https://github.com/nodef/extra-typedoc-theme
TypeDoc theme for extra-* packages.
https://github.com/nodef/extra-typedoc-theme
extra load theme typedoc
Last synced: 4 months ago
JSON representation
TypeDoc theme for extra-* packages.
- Host: GitHub
- URL: https://github.com/nodef/extra-typedoc-theme
- Owner: nodef
- License: mit
- Created: 2022-10-04T15:10:08.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-09T09:06:47.000Z (about 1 year ago)
- Last Synced: 2025-04-14T07:06:18.487Z (about 1 year ago)
- Topics: extra, load, theme, typedoc
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/extra-typedoc-theme
- Size: 63.5 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
TypeDoc theme for extra-* packages (v0.24).
📦 [Node.js](https://www.npmjs.com/package/extra-typedoc-theme),
📜 [Files](https://unpkg.com/extra-typedoc-theme/).
[TypeDoc] is a documentation generator for TypeScript projects. TypeDoc adds
*suffix* to filenames of generated HTML documentation by default when symbols only
*differ by case*. For example, you may have a function called `orderValidity()`
and a type called `OrderValidity`. This is done to avoid the case when a theme
puts all the generated files in the *same directory* on a *case-insensitive file*
*system*. However, the default theme places the functions and types in *different*
*directories*, and thus it should **not** be an issue. This package is a TypeDoc theme
which removes URL suffixes (`function-1.html` → `function.html`) in order to
enable **simple linking** to generated HTML documentation.
[TypeDoc]: https://www.npmjs.com/package/typedoc
```bash
## Install as dev-dependency to you project.
$ npm install --save-dev extra-typedoc-theme
## Generate docs through typedoc while using this theme.
$ typedoc --plugin extra-typedoc-theme "src/index.ts" --out ".docs"
```
[](https://www.youtube.com/watch?v=kQZ2nA2GpXw)
[](https://nodef.github.io)
