@urpflanze/typedoc-docs
v0.1.15
Published
Generate docs site (or references) for typescript project
Downloads
28
Readme
Typedoc-Docs
Motivations
This package comes from the need to generate documentation from a typescript project by applying a custom style.
As a first step I felt the need to simplify the file generated by the command
typedoc. --json <path/to/out-file.json>
In order to have a more readable result and therefore easier to manage.
The style is still tied to urpflanze, but it could become an isolated package.
Installation
Install with npm
npm i -D @urpflanze/typedoc-docs
add generate-docs in your package.json
"scripts": {
"generate-docs": "npx generate-docs"
}
Testing
After the generation you will have to change the value of the base tag if you want to test it locally
file docs/index.html
change
<base href="/.../" />
to
<base href="/" />
and run server in docs
dir (for example: php -S localhost:8080)