1.2.9 • Published 2 years ago

@yuko1101/jsdoc-to-mdx v1.2.9

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

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
}
1.2.9

2 years ago

1.2.8

2 years ago

1.2.7

2 years ago

1.2.6

2 years ago

1.2.5

2 years ago

1.2.4

2 years ago

1.2.3

2 years ago

1.2.2

2 years ago

1.2.1

2 years ago