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.

Sign up for GitHub

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

Jump to bottom

Feature: API Docs #56

Open

rdwz wants to merge 2 commits into helmasaur:main from astrological-guru:feat-api-docs

rdwz commented Nov 30, 2023 •

edited

Loading

Everyone has probably seen something like this:

/**

This is a function.
@param {string} in - some param
@return {string} the result
*/

function foo(in) {
return out
}

JSDoc

And from there we can generate a complete Documentation of each available function

{
"scripts": {
"docs": "jsdoc2md index.js > docs/api.md"
}
}

JSDoc2MD

CI added 2 commits

November 30, 2023 16:55


          📝 Add JSDoc for every function

ab892d3


          ✨ Generate docs with jsdoc-to-markdown

7a4d352

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

Labels

None yet