jsdoc-to-mdx
v1.2.1
Published
jsdoc to mdx API document generator
Downloads
1,137
Keywords
Readme
jsdoc-to-mdx
jsdoc to mdx API document generator.
This module is designed for use with docusaurus v2
Options
- "-c, --config ", "path to the config file"
- "-o, --outDir ", "path to the generated mdx files"
- "-l, --locales [locales...]", "locales to enable"
- "-d, --localesDir ", "path to the locales document"
- "-s, --sidebar ", "path to the generate sidebar-api.js for Docusaurus v2"
- "-p, --prefix ", "path prefix of the sidebar items. Should end with '/', default is "api/""
- "-j, --jsdoc ", "path to the jsdoc config"
- "-b, --bulma", "use Bulma's classes instead of Infima"
Config example
{
"locales": ["ko"],
"outDir": "./docs/docs/api",
"localesDir": "./docs/i18n/{locale}/docusaurus-plugin-content-docs/current/api",
"sidebar": "./docs",
"jsdoc": "./jsdoc.json",
"bulma": false
}