ts-docs
An opinionated documentation generator for typescript - generate informative and accurate documentation sites with zero setup.
If you want to check out how a typical ts-docs documentation looks like, head over to the official docs, found here.
Installation
Important: You need typescript 4.3+ in order to use ts-docs!
npm i --save-dev @ts-docs/ts-docs @ts-docs/default-docs-structure Usage
In order for ts-docs to generate proper documentation, you need to give it one or multiple "project entry points". Every entry point should point to a different project. You can find out more information about all the options ts-docs has here.
Simple usage which uses the default options:
ts-docs src/index.tsFeatures
- Documentation structure akin to docs-rs and rust in general, every folder inside the project is a different module.
- Document multiple projects, monorepo support out of the box.
- Slick design, dark/light theme, powerful search and filter function.
- Link external references to their respective documentation.
- Out of the box documentation generation for different branches of your repository.
- Changelog generation, pulled from github releases.
- Built-in custom pages support. Host your guides and tutorials right inside the documentation.
- 100% accurate, you won't find missing references unless they're external.
- Unit tests inside documentation comments.
Examples
ts-docs
detritus
Contributing
Contributions are appreciated, feel free to open an issue or a pull request here.
Make sure to read the contribution guide.