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

Automate the insertion of the JSDocs build into Website #72

Open
stalgiag opened this issue Sep 6, 2019 · 2 comments
Open

Automate the insertion of the JSDocs build into Website #72

stalgiag opened this issue Sep 6, 2019 · 2 comments
Labels
documentation help wanted Extra attention is needed

Comments

@stalgiag
Copy link
Owner

stalgiag commented Sep 6, 2019

I am manually adding the API Reference to the website. This is okay for now but will eventually need to be extracted from comments in the source. We have JSDocs for generating a documentation website but that is no longer in use.

The todo is to automate the extraction of inline comments, output markdown, add it to the appropriate reference docs.

@stalgiag stalgiag added the help wanted Extra attention is needed label Mar 30, 2020
@stalgiag stalgiag mentioned this issue Mar 3, 2021
@msub2
Copy link
Contributor

msub2 commented Mar 3, 2021

This seems like exactly the tool for the markdown generation: https://github.com/jsdoc2md/jsdoc-to-markdown. I could take a look in a couple of days and see if I can get something going

@stalgiag
Copy link
Owner Author

stalgiag commented Mar 5, 2021

Awesome find! Yes that is exactly what we need.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants