Skip to content

Comments

jsdoc to markdown functionality added#89

Open
pankaj2k9 wants to merge 5 commits intomasterfrom
adding-markdown-converter-functionality
Open

jsdoc to markdown functionality added#89
pankaj2k9 wants to merge 5 commits intomasterfrom
adding-markdown-converter-functionality

Conversation

@pankaj2k9
Copy link

No description provided.

@digisomni
Copy link
Member

This is for use in Docusaurus.

@ctrlaltdavid
Copy link
Collaborator

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants