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

Remove TypeDoc dependency #342

Closed
donmccurdy opened this issue Aug 26, 2021 · 2 comments · Fixed by #940
Closed

Remove TypeDoc dependency #342

donmccurdy opened this issue Aug 26, 2021 · 2 comments · Fixed by #940
Labels
code health dependencies Pull requests and issues related to dependencies documentation
Milestone

Comments

@donmccurdy
Copy link
Owner

donmccurdy commented Aug 26, 2021

Currently documentation is generated with TypeDoc. I'd like to switch to API Extractor for a few reasons:

  • well-defined declarative JSON output
  • easier to write/maintain a custom theme (see Upgrade to typedoc v0.20 #234)
  • able to customize navigation without hand-writing each link
  • hopefully more stable, have been hitting issues with TypeDoc historically, and had a major breaking change in patch release v0.21.3 with no fix planned

I think the idea here would be to:

  1. Confirm I can get API Extractor JSON output for this monorepo.
  2. Find or build an HTML/MD documentation generator (separate package)
  3. Rewrite my theme for the generator
  4. Put it all together

https://api-extractor.com/pages/setup/custom_docs/


Could also consider sticking with TypeDoc but switching to its JSON output mode. Most of the issues above are really complaints about the lack of a robust theming API.

@donmccurdy donmccurdy added code health documentation dependencies Pull requests and issues related to dependencies labels Aug 26, 2021
@donmccurdy donmccurdy added this to the Backlog milestone Aug 26, 2021
@donmccurdy
Copy link
Owner Author

donmccurdy commented Aug 26, 2021

@donmccurdy donmccurdy changed the title Use "API Extractor" to generate documentation / website Remove TypeDoc dependency May 8, 2023
@donmccurdy
Copy link
Owner Author

After some experiments with both API Extractor and TS Morph, I think TS Morph might be the more practical way to go here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code health dependencies Pull requests and issues related to dependencies documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant