Skip to main content

Config

Configs can be provided either by command line parameters or config file with JSON format.

Sample config.json#

config.json
{  "locales": ["ko"],  "outDir": "./docs/docs/api",  "localesDir": "./docs/i18n/{locale}/docusaurus-plugin-content-docs/current/api",  "sidebar": "./docs",  "jsdoc": "./jsdoc.json",  "bulma": false}

Sample shell script#

npx jsdoc-to-mdx -o "docs/api" -s "docs" -j "jsdoc.json"

Sample shell script (when using the config file)#

npx jsdoc-to-mdx -c config.json

locales#

  • type: string[]
  • -l, --locales

An array of locale strings to enable.
This will separate all descriptions inside jsdoc that starts with @"TARGET_LOCALE" and <TARGET_LOCALE></TARGET_LOCALE> then save them where it specified on the localesDir

JSDoc Example)

/** * Class Property A * @ko 클래스 프로퍼티 A * @type {string} * @readonly * @example * ```ts * new DummyClass("b").propA === "b"; * ``` *//** * Method A * @param {number} a description of param a<ko>패러미터 A의 설명</ko> * @param {string} [b="DUMMY_TEXT"] description of param b<ko>패러미터 B의 설명</ko> */

outDir#

  • type: string
  • -o, --outDir

Path to generate mdx files.

localesDir#

  • type: string
  • -d, --localesDir

Path to generate mdx files with locales applied.
If the locale name should be applied to the path name, you can include the special string {locale} then it will automatically transform into the target locale name.

sidebar#

  • type: string
  • -s, --sidebar

Path to generate sidebar-api.js that can be used to show the sidebar of the generated API documents.

prefix#

  • type: string
  • -p, --prefix

Path prefix of the generated sidebar items.
Should end with /, and default is api/.

jsdoc#

  • type: string
  • -j, --jsdoc

Path to the jsdoc config file.

bulma#

  • type: boolean
  • -b, --bulma

If enabled, generated documents will have Bulma's classes instead of Infima's.
Additional SCSS file to load Bulma's CSS is required.