vircadia-web-sdk icon indicating copy to clipboard operation
vircadia-web-sdk copied to clipboard

jsdoc to markdown functionality added

Open pankaj2k9 opened this issue 3 years ago • 2 comments

pankaj2k9 avatar Feb 18 '22 14:02 pankaj2k9

This is for use in Docusaurus.

digisomni avatar Apr 05 '22 01:04 digisomni

npm run generate-jsdoc-to-markdown This converts HTML documentation into markdown in \docs\markdown However, it isn't well formatted and includes a lot of Vue/Vuetify code which is rendered as text.

npm run markdown-docs This runs typedoc on the code and generates markedown in \vircadia-dev-docs The output includes private members etc. which is unwanted. No text is included because all text is currently in Vircadia-specific JSDoc comments. Global replace of /*@sdkdoc with /** creates better looking output, though it still includes private members. Note: Lots of Docusaurus warnings/errors to fix up.

ctrlaltdavid avatar Aug 07 '22 22:08 ctrlaltdavid