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

Auto-generate documentation from JSDoc #25

Closed

alex-titarenko opened this issue Oct 3, 2022 · 5 comments · Fixed by #29

Labels

Contributor

alex-titarenko commented Oct 3, 2022 •

edited

Loading

https://github.com/andstor/jsdoc-action
https://www.gitbook.com/
https://medium.com/@kevinast/integrate-gitbook-jsdoc-974be8df6fb3

alex-titarenko added the documentation label

Contributor Author

alex-titarenko commented Oct 3, 2022 •

edited

Loading

jsdoc3 template list examples:
https://cancerberosgx.github.io/jsdoc-templates-demo/demo/

https://github.com/ankitskvmdam/clean-jsdoc-theme

Contributor Author

alex-titarenko commented Oct 3, 2022

Project icon: https://www.flaticon.com/free-icon/git_4908200?term=git&page=1&position=17&page=1&position=17&related_id=4908200&origin=search

Contributor Author

alex-titarenko commented Oct 3, 2022 •

edited

Loading

We may need to do extra work to support Typescript with JSDoc
https://www.npmjs.com/package/jsdoc-plugin-typescript

https://blog.cloudflare.com/generating-documentation-for-typescript-projects/
https://github.com/TypeStrong/typedoc

TypeStrong/typedoc#1485

Contributor Author

alex-titarenko commented Oct 5, 2022 •

edited

Loading

TypeDoc GitHub Actions deployment
TypeStrong/typedoc#1485
https://github.com/TypeStrong/typedoc-action !!! not working

Contributor Author

alex-titarenko commented Oct 6, 2022 •

edited

Loading

Try uploading to GitHub Wiki:
typedoc2md/typedoc-plugin-markdown#118
https://github.com/marketplace/actions/publish-to-github-wiki

alex-titarenko linked a pull request

that will close this issue

25 auto generate documentation from jsdoc #29

Merged

alex-titarenko closed this as completed in #29

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