-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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: Generated documentation #1777
Comments
I will gladly setup JSDoc and document |
No strong opinions, but is our API large enough to warrant something like this? |
I gave a look at the #1782 PR thread and saw that JSDoc may not be coming soon. As a user of this library I would love to have a bit more throughtfull documentation. Maybe until that is done we can compile a list of things to improve on the doc and push that forward? Just having a complete documentation of the main API methods, probably in a separate page, would be enough IMO. Maybe on top of something like https://docsify.js.org/ with a couple of |
Thank you @RunDevelopment ❤️ |
Why don't we use JSDoc to add generated code documentation to the prismjs.com website? I'm thinking about something like
prismjs.com/docs/
.The generated documentation will include all documented variables/functions of
components/prism-core.js
. Functions that aren't documented won't show up in the doc.I already tested this a little and it works quite well.
This is intended to replace the API section of extending Prism to keep Core and its documentation more in sync to avoid issues like #1774.
(We can also use this include API docs for plugins and components like markup templating in the future.)
Thoughts?
@mAAdhaTTah @Golmote @LeaVerou
The text was updated successfully, but these errors were encountered: