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.

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

Generate documentation using TypeDoc #114

Open
2 tasks
meduzen opened this issue Feb 22, 2024 · 0 comments
Open
2 tasks

Generate documentation using TypeDoc #114

meduzen opened this issue Feb 22, 2024 · 0 comments
Assignees
@meduzen
Labels
documentation Improvements or additions to documentation

Comments

@meduzen
Copy link
Owner

meduzen commented Feb 22, 2024 •
edited
Loading

npx typedoc src/index.js is enough to get the following from TypeDoc:

Index showing `README.md`

image

`DateTime` class view image
functions view

image

image

  • use TypeDoc;
  • host it somewhere using a CI (GitHub page, my own website…), and consider versioning (like Laravel does).
@meduzen meduzen added the documentation Improvements or additions to documentation label Feb 22, 2024
@meduzen meduzen self-assigned this Feb 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@meduzen meduzen

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@meduzen