Skip to content

michalfedyna/docs-typescript

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

85 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Docs TypeScript - Documenting TypeScript made easy

npm version

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.json and tsdoc.json files with default values
npx docs-typescript init

Extract API Model from declaration files

  • Defaults to types/index.d.ts file
npx docs-typescript extract

Build documentation form API Model

  • Defaults to api.json file, creates docs folder with documentation
npx docs-typescript build

Documentation

For all the details see DocsTypeScript.com, for API documentation see DocsTypeScript.com/api (Work in Progress)

Examples

Supported TSDoc tags

  • @link
  • @remarks
  • @example
  • @type
  • @typeParam
  • @returns
  • @info
  • @warning
  • @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 @link tag
  • 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

Releases

No releases published