Document 📃

This CLI tool brings TypeDoc documentation generation to your TypeScript project.

typedoc 🎁

typedoc-plugin-keywords 🎁

typedoc-plugin-mdn-links 🎁

typedoc-plugin-merge-modules 🎁

typedoc-plugin-remove-references 🎁

typedoc-plugin-rename-defaults 🎁

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:

npm install -D -E @playform/document

Using Yarn:

yarn add -D -E @playform/document

Using PNPM:

pnpm add -D -E @playform/document

Run directly

Using NPM:

npx @playform/document 'Source/**/*.ts'

Using Yarn:

yarn dlx @playform/document 'Source/**/*.ts'

Using PNPM:

pnpx @playform/document 'Source/**/*.ts'

Getting started

Add a Document script to your package.json:

package.json

{
	"scripts": {
		"Document": "Document 'Source/**/*.ts'"
	}
}

Then run it:

npm run Document

Documentation is written to ./Documentation by default.

Custom output folder

Use --Folder to write to a different directory:

Document 'Source/**/*.ts' --Folder docs

package.json

{
	"scripts": {
		"Document": "Document 'Source/**/*.ts' --Folder docs"
	}
}

Multiple entry patterns

Pass additional glob patterns as extra arguments:

Document 'Source/**/*.ts' 'Test/**/*.ts'

Changelog

See CHANGELOG.md for a history of changes to this tool.