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

Docs: Documentation generation via Typedoc #4

Closed
jojobii-arks opened this issue Dec 20, 2022 · 3 comments
Closed

Docs: Documentation generation via Typedoc #4

jojobii-arks opened this issue Dec 20, 2022 · 3 comments

Comments

@jojobii-arks
Copy link

Issue

  • Since this project is using JSDoc, the site generation that JSDoc provides could be leveraged in order to create a basic site for documentation.
@jojobii-arks
Copy link
Author

NVM, misunderstood the usage of JSDoc with TypeScript; import isn't JSDoc standard

I bet there's a way to leverage the current annotations though...

@jojobii-arks
Copy link
Author

Reopening, I found a solution that works with the syntax being used for this project: https://typedoc.org/

@jojobii-arks jojobii-arks reopened this Dec 20, 2022
@jojobii-arks jojobii-arks mentioned this issue Dec 20, 2022
Closed
@jojobii-arks jojobii-arks changed the title Docs: Documentation generation via JSDoc CLI Docs: Documentation generation via Typedoc Dec 20, 2022
@jojobii-arks
Copy link
Author

stale; closing

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: Implement automatic site generation of package documentation. jojobii-arks/musakui-fedi
1 participant
@jojobii-arks