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.

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

Automatically build API documentation #11

Merged
merged 36 commits into from
Mar 3, 2021
Merged

Automatically build API documentation #11

merged 36 commits into from
Mar 3, 2021

Conversation

mrousavy
Copy link
Owner

@mrousavy mrousavy commented Mar 2, 2021

Automatically builds API documentation (A static website in docs/, will be hosted using GitHub pages) from the JSDoc comments in the TypeScript source files.

Closes #10

Blocker

  • It doesn't pick up export type ..., only export interface ... works :(
  • The default theme is ugly as hell

@mrousavy mrousavy added the 📚 documentation Improvements or additions to documentation label Mar 2, 2021
@mrousavy mrousavy marked this pull request as ready for review March 3, 2021 11:37
@mrousavy mrousavy merged commit 0b7b4d5 into main Mar 3, 2021
@mrousavy mrousavy deleted the jsdoc branch March 3, 2021 11:37
@palagonKevo palagonKevo mentioned this pull request Mar 31, 2022
4 tasks
@agrittiwari
Copy link

I was reading source code and API documentation, then read the commit/ title for this. What is it, the source code is generating API doc for !!

@MajorTom007 MajorTom007 mentioned this pull request Nov 14, 2023
4 tasks
@cseluzha cseluzha mentioned this pull request Dec 12, 2023
5 tasks
isaaccolson pushed a commit to isaaccolson/deliveries-mobile that referenced this pull request Oct 30, 2024
* Automatically build API documentation using Typedoc and Docusaurus
* Move MD and move to MDX for Docusaurus Guides
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

❓ API docs?
2 participants