Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

jsdoc to markdown functionality added #89

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

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