https://github.com/playform/document
Document 📃
https://github.com/playform/document
document documentation javascript playform typedoc typescript
Last synced: 20 days ago
JSON representation
Document 📃
- Host: GitHub
- URL: https://github.com/playform/document
- Owner: PlayForm
- License: cc0-1.0
- Created: 2024-03-17T22:09:43.000Z (about 2 years ago)
- Default Branch: Current
- Last Pushed: 2026-04-05T03:20:23.000Z (22 days ago)
- Last Synced: 2026-04-05T05:15:07.283Z (22 days ago)
- Topics: document, documentation, javascript, playform, typedoc, typescript
- Language: TypeScript
- Homepage: https://PlayForm.GitHub.Io/Document
- Size: 1.42 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Related
🔧 Maintain — 
🗻 Format —
# [Document] 📃
This **[`CLI tool`][Document]** brings TypeDoc documentation generation to your
TypeScript project.
[`typedoc`][typedoc] 🎁
[`typedoc-plugin-keywords`][typedoc-plugin-keywords] 🎁
[`typedoc-plugin-mdn-links`][typedoc-plugin-mdn-links] 🎁
[`typedoc-plugin-merge-modules`][typedoc-plugin-merge-modules] 🎁
[`typedoc-plugin-remove-references`][typedoc-plugin-remove-references] 🎁
[`typedoc-plugin-rename-defaults`][typedoc-plugin-rename-defaults] 🎁
[`typedoc-plugin-zod`][typedoc-plugin-zod] 🎁
> **Note**
>
> `Document` is git-aware — it reads the current branch and remote to generate
> correct source links in the documentation.
## Installation 🚀
There are two ways to add `Document` to your project. Let's try the most
convenient option first!
### Install as a dev dependency
Using NPM:
```sh
npm install -D -E @playform/document
```
Using Yarn:
```sh
yarn add -D -E @playform/document
```
Using PNPM:
```sh
pnpm add -D -E @playform/document
```
### Run directly
Using NPM:
```sh
npx @playform/document 'Source/**/*.ts'
```
Using Yarn:
```sh
yarn dlx @playform/document 'Source/**/*.ts'
```
Using PNPM:
```sh
pnpx @playform/document 'Source/**/*.ts'
```
## Getting started
Add a `Document` script to your `package.json`:
**`package.json`**
```json
{
"scripts": {
"Document": "Document 'Source/**/*.ts'"
}
}
```
Then run it:
```sh
npm run Document
```
Documentation is written to `./Documentation` by default.
### Custom output folder
Use `--Folder` to write to a different directory:
```sh
Document 'Source/**/*.ts' --Folder docs
```
**`package.json`**
```json
{
"scripts": {
"Document": "Document 'Source/**/*.ts' --Folder docs"
}
}
```
### Multiple entry patterns
Pass additional glob patterns as extra arguments:
```sh
Document 'Source/**/*.ts' 'Test/**/*.ts'
```
[Document]: HTTPS://NPMJS.Org/@playform/document
[typedoc]: HTTPS://NPMJS.Org/typedoc
[typedoc-plugin-keywords]: HTTPS://NPMJS.Org/typedoc-plugin-keywords
[typedoc-plugin-mdn-links]: HTTPS://NPMJS.Org/typedoc-plugin-mdn-links
[typedoc-plugin-merge-modules]: HTTPS://NPMJS.Org/typedoc-plugin-merge-modules
[typedoc-plugin-remove-references]:
HTTPS://NPMJS.Org/typedoc-plugin-remove-references
[typedoc-plugin-rename-defaults]:
HTTPS://NPMJS.Org/typedoc-plugin-rename-defaults
[typedoc-plugin-zod]: HTTPS://NPMJS.Org/typedoc-plugin-zod
## Changelog
See [`CHANGELOG.md`](CHANGELOG.md) for a history of changes to this tool.