docs: fix code block titles (#5733)

* docs: fix code block titles

* remove console

* fix build error
This commit is contained in:
Shahed Nasser
2023-11-27 16:08:10 +00:00
committed by GitHub
parent de8f748674
commit 547b16ead5
110 changed files with 483 additions and 456 deletions

View File

@@ -149,7 +149,7 @@ Where:
Here's an example implementation of `index.ts` from Medusa's Redis Cache module:
```ts title=index.ts
```ts title="index.ts"
import { ModuleExports } from "@medusajs/modules-sdk"
import Loader from "./loaders"
@@ -172,7 +172,7 @@ export default moduleDefinition
To use your module in the Medusa backend, add your module to `medusa-config.js`:
```js title=medusa-config.js
```js title="medusa-config.js"
module.exports = {
// ...
modules: {
@@ -200,7 +200,7 @@ The way you add your module depends on its type and what options it requires, if
When the module is installed as an NPM package, the value of the `resolve` property should be the name of that package. For example:
```js title=medusa-config.js
```js title="medusa-config.js"
module.exports = {
// ...
modules: {
@@ -238,7 +238,7 @@ You can reference your module in two ways:
1\. Referencing the directory: In this case, it's assumed that the `index.ts` file that contains the module definition is in the root of the directory you referenced. Using the above example, the file path would be in this case:
```js title=medusa-config.js
```js title="medusa-config.js"
module.exports = {
// ...
modules: {
@@ -253,7 +253,7 @@ module.exports = {
2\. Referencing `index` file: In this case, it's assumed that the `index.ts` or `index.js` file you're referencing includes the module definition. Using the above example, the file path would be in this case:
```js title=medusa-config.js
```js title="medusa-config.js"
module.exports = {
// ...
modules: {
@@ -272,7 +272,7 @@ By default, the module shares the same dependency container used across the Medu
The module's scope can be changed using the `resources` property available as part of the module's configurations:
```js title=medusa-config.js
```js title="medusa-config.js"
module.exports = {
// ...
modules: {

View File

@@ -35,7 +35,7 @@ Once youre done, you should have a `package.json` created in the directory.
In your `package.json` file, add or update the following fields:
```json title=package.json
```json title="package.json"
{
// other fields
"main": "dist/index.js",
@@ -73,7 +73,7 @@ This adds the necessary dependencies for development and publishing, including t
If you don't already have a `tsconfig.json` file, create one in the root of your NPM project with the following content:
```json title=tsconfig.json
```json title="tsconfig.json"
{
"compilerOptions": {
"lib": [
@@ -162,7 +162,7 @@ Where `module-name` is the name of your module.
In `medusa-config.js` on your Medusa backend, add your module to the exported configurations:
```js title=medusa-config.js
```js title="medusa-config.js"
module.exports = {
// ...
modules: {