Skip to content

daybrush/jsdoc-to-mdx

 
 

Repository files navigation

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"
  • "-j, --jsdoc", "path to the jsdoc config"

Config example

{
  "locales": ["ko"],
  "outDir": "docs/api",
  "localesDir": "docs/i18n",
  "sidebar": "docs",
  "jsdoc": "jsdoc.json"
}

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 98.6%
  • JavaScript 1.4%