docs-typescript
v0.1.7
Published
Tool for documenting Typescript based projects
Maintainers
Readme
Docs Typescript - Documenting Typescript made easy
Tool for documenting Typescript APIs using API Extractor Model with support for Markdown, Docusaurus (WIP) and HTML (WIP). Alternative to api-documenter and TypeDoc with better UX, much richer API presentation and support for single and multi page documentation.
Getting Started
Create configuration
- Creates
docs.config.json,api-extractor.jsonandtsdoc.jsonfiles with default values
npx docs-typescript initExtract API Model from declaration files
- Defaults to
types/index.d.tsfile
npx docs-typescript extractBuild documentation form API Model
- Defaults to
api.jsonfile, createsdocsfolder with documentation
npx docs-typescript buildDocumentation
For all the details see DocsTypescript.com, for API documentation see DocsTypescript.com/api (Work in Progress)
Examples
Supported TSDoc tags
@remarks@example@type@typeParam@returns@info@alert@error@author@since@public@beta@alpha@internal@deprecated
For more informations visit Doc comment syntax
Roadmap
- [ ] Markdown support
- [ ] Single page / Multi page
- [ ] Project website
- [ ] Support for
@linktag - [ ] React support (categories for components/hooks/providers)
- [ ] Mermaid support to present inheritance and dependencies
- [ ] Create and use api-extractor alternative in form of extractor-typescript
- [ ] Docusaurus (MDX) output support
- [ ] HTML output support
