{"_id":"@cask/jsdoc-to-mdx","name":"@cask/jsdoc-to-mdx","dist-tags":{"latest":"1.2.3"},"versions":{"1.2.3":{"name":"@cask/jsdoc-to-mdx","version":"1.2.3","description":"jsdoc to mdx API document generator","main":"index.js","scripts":{"generate":"ts-node -O '{\"module\":\"commonjs\"}' ./src/generate.ts -c config.json","build":"rollup -c","publish:demo":"npm run build --prefix docs && gh-pages -d docs/build/ --add --remote upstream"},"bin":{"jsdoc-to-mdx":"bin/generate.js"},"license":"MIT","dependencies":{"commander":"^9.4.1","fs-extra":"^10.0.0","jsdoc-parse":"^6.2.1","jsdoc-to-markdown":"^8.0.1","tmp-promise":"^3.0.3"},"devDependencies":{"@egjs/build-helper":"^0.1.2","@rollup/plugin-commonjs":"^18.1.0","@types/node":"^15.0.1","gh-pages":"^3.2.3","rollup":"^2.47.0","rollup-plugin-banner2":"^1.2.2","rollup-plugin-typescript2":"^0.30.0","ts-node":"^9.1.1","tslib":"^2.2.0","typescript":"^4.2.4"},"packageManager":"yarn@4.1.0","_id":"@cask/jsdoc-to-mdx@1.2.3","gitHead":"ea1f82042c1a7be9ff1ed4746ea8ad37f06ff3b8","_nodeVersion":"20.12.2","_npmVersion":"10.5.0","dist":{"integrity":"sha512-1mCAedDGAvKLcMb5IHRGszEz3DGFDhK4xHjFkALRxukARc0ZmFd6unmdN2JKZOfBRHDq6ij8ioVaq2VwGmBEcg==","shasum":"ef4476a849b792197f56420a26206b3ce44aa529","tarball":"https://registry.npmjs.org/@cask/jsdoc-to-mdx/-/jsdoc-to-mdx-1.2.3.tgz","fileCount":29,"unpackedSize":68528,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDJIXVaurce7o4+AACXrqgpIno9xJN5/JtvPXkud5u48gIgPDzcxqwHIYcK5o7m9E95HWjXVgcB2OKvEbYt+vphScE="}]},"_npmUser":{"name":"josephbolt","email":"plumhorse83@gmail.com"},"directories":{},"maintainers":[{"name":"josephbolt","email":"plumhorse83@gmail.com"},{"name":"catesandrew","email":"catesandrew@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/jsdoc-to-mdx_1.2.3_1720977183549_0.9535745320181741"},"_hasShrinkwrap":false}},"time":{"created":"2024-07-14T17:13:03.444Z","1.2.3":"2024-07-14T17:13:03.812Z","modified":"2024-07-14T17:13:04.116Z"},"maintainers":[{"name":"josephbolt","email":"plumhorse83@gmail.com"},{"name":"catesandrew","email":"catesandrew@gmail.com"}],"description":"jsdoc to mdx API document generator","license":"MIT","readme":"# jsdoc-to-mdx\n\njsdoc to mdx API document generator.\n\nThis module is designed for use with [docusaurus v2](https://docusaurus.io/)\n\n## Options\n- \"-c, --config <path>\", \"path to the config file\"\n- \"-o, --outDir <path>\", \"path to the generated mdx files\"\n- \"-l, --locales [locales...]\", \"locales to enable\"\n- \"-d, --localesDir <path>\", \"path to the locales document\"\n- \"-s, --sidebar <path>\", \"path to the generate sidebar-api.js for Docusaurus v2\"\n- \"-p, --prefix <prefix>\", \"path prefix of the sidebar items. Should end with '/', default is \\\"api/\\\"\"\n- \"-j, --jsdoc <path>\", \"path to the jsdoc config\"\n- \"-b, --bulma\", \"use Bulma's classes instead of Infima\"\n\n## Config example\n```json\n{\n  \"locales\": [\"ko\"],\n  \"outDir\": \"./docs/docs/api\",\n  \"localesDir\": \"./docs/i18n/{locale}/docusaurus-plugin-content-docs/current/api\",\n  \"sidebar\": \"./docs\",\n  \"jsdoc\": \"./jsdoc.json\",\n  \"bulma\": false\n}\n```\n","readmeFilename":"README.md"}