JS Doc to Docusauros

[201flaviosilva]

Hey there,

I'm developing a simple canvas rendering library, currently I've documented practically all the code, based on JS Doc.

But currently, I'm having difficulties in merging the documentation generated by JS Doc with the docusauros documentation.

Does anyone know how to do this magic? 😅

[Josh-Cena]

Hey, you might be interested in TypeDoc?

You can also play around with docusaurus-plugin-typedoc

[201flaviosilva]

No, my code in pure JavaScript, so I don’t think this will work for me, but thanks, any way 😁

[Josh-Cena]

TypeDoc works on JS files as well (iirc), as long as there's JSDoc. It's just you don't get type documentation, only the prose.

[201flaviosilva]

Oh I didn't know, how do I make this work? 😅

[201flaviosilva]

Here is my plugin solution: https://github.com/201flaviosilva/Impacto/blob/e575ac973452af4468a56279ee3d0a797d96e9fa/docs/plugins/jsdoc2docusaurus.js

And my docusaurus.config.js: https://github.com/201flaviosilva/Impacto/blob/e575ac973452af4468a56279ee3d0a797d96e9fa/docs/docusaurus.config.js

[jtbandes]

In case anyone else is looking for more solutions, here are some I found in a quick search:

• https://gist.github.com/slorber/0bf8c8c8001505f0f99a062ac55bf442
• https://github.com/naver/jsdoc-to-mdx
• https://typedoc-plugin-markdown.org/plugins/docusaurus/quick-start