Item path prefixes in generated sidebars

naver / jsdoc-to-mdx

jsdoc to mdx API document generator

https://naver.github.io/jsdoc-to-mdx/

MIT License

20 stars 5 forks source link

Item path prefixes in generated sidebars #5

Open birdofpreyru opened 3 years ago

birdofpreyru commented 3 years ago

It seems, no matter the actual config, the item paths in generated sidebar files always start with api/, which works for default paths, but does not work for different paths (e.g. if instead of api sub-folder of docs one want to output mdx files into a separate folder inside Docusaurus project, and configure a separate content plugin instance to handle that folder).

WoodNeck commented 3 years ago

I can confirm this is a bug due to the hard-coded paths on the Sidebar.ts, and it can be easily fixed with the additional config like sidebarPrefix, or automatically detecting it by parsing the outDir. I should work on it soon :)