https://github.com/ts-docs/ts-docs
A documentation generator for typescript. Generate beautiful and informative documentation with zero setup!
https://github.com/ts-docs/ts-docs
docs documentation generator typescript typescript-docs
Last synced: 8 months ago
JSON representation
A documentation generator for typescript. Generate beautiful and informative documentation with zero setup!
- Host: GitHub
- URL: https://github.com/ts-docs/ts-docs
- Owner: ts-docs
- License: mit
- Created: 2021-07-30T17:53:41.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-07-20T16:57:12.000Z (almost 2 years ago)
- Last Synced: 2024-12-12T21:47:21.671Z (over 1 year ago)
- Topics: docs, documentation, generator, typescript, typescript-docs
- Language: TypeScript
- Homepage: https://ts-docs.github.io/ts-docs/
- Size: 3.65 MB
- Stars: 74
- Watchers: 1
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# ts-docs
[](https://github.com/ts-docs/ts-docs/blob/main/LICENSE)
[](https://github.com/ts-docs/ts-docs/stargazers)
[](https://github.com/ts-docs/ts-docs/issues)
[](https://www.codacy.com/gh/ts-docs/ts-docs/dashboard?utm_source=github.com&utm_medium=referral&utm_content=ts-docs/ts-docs&utm_campaign=Badge_Grade)
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](https://ts-docs.github.io/ts-docs/index.html).
## 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](https://ts-docs.github.io/ts-docs/pages/Guides/Options.html).
Simple usage which uses the default options:
```
ts-docs src/index.ts
```
## Features
- Documentation structure akin to [docs-rs](https://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](https://github.com/ts-docs/ts-docs).
Make sure to read the [contribution guide](https://github.com/ts-docs/ts-docs/blob/main/.github/CONTRIBUTING.md).