https://github.com/jjwesterkamp/typedoc-theme
The Typedoc theme that I use for my projects.
https://github.com/jjwesterkamp/typedoc-theme
color-theme documentation nord theme typedoc
Last synced: 8 months ago
JSON representation
The Typedoc theme that I use for my projects.
- Host: GitHub
- URL: https://github.com/jjwesterkamp/typedoc-theme
- Owner: JJWesterkamp
- License: mit
- Created: 2021-04-11T18:14:25.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2021-04-25T21:51:54.000Z (about 5 years ago)
- Last Synced: 2025-02-24T09:47:59.095Z (over 1 year ago)
- Topics: color-theme, documentation, nord, theme, typedoc
- Language: CSS
- Homepage:
- Size: 64.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @jjwesterkamp/typedoc-theme
The [Typedoc] theme that I use for my projects. You can find examples here:
- [lambda-dom documentation](https://jjwesterkamp.github.io/lambda-dom)
- [event-delegation documentation](https://jjwesterkamp.github.io/event-delegation)
## Usage
```
npm install --save-dev @jjwesterkamp/typedoc-theme
```
Add the theme to your `typedoc.json` file. This theme is optimized for the _nord_ highlight theme, so it's recommended to add that too:
```json
{
"theme": "./node_modules/@jjwesterkamp/typedoc-theme",
"highlightTheme": "nord"
}
```
## License
The MIT License (MIT). See [license file] for more information.
[Typedoc]: https://typedoc.org/
[license file]: https://github.com/JJWesterkamp/lambda-dom/blob/master/LICENSE