typedoc-theme-fresh
v0.2.3
Published
A clean, minimalist and well-designed theme for TypeDoc
Maintainers
Readme
typedoc-theme-fresh
Fresh is a clean and minimalist theme for TypeDoc.
The default TypeDoc theme is a bit noisy visually, and the layout seems haphazard in spots. This theme is intended to help put content first and adjusts:
- Color palette
- Icon set and UI coherence
- Typographic size and spacing
- Visual consistency (borders, backgrounds, underlines)
You can also use it as a base upon which to build your own themes.
Usage
npm i -D typedoc-theme-freshThen, you can run TypeDoc with the plugin and theme:
typedoc --plugin typedoc-theme-fresh --theme fresh [etc...]Development
If you'd like to fork and make changes to the theme itself, or if you're submitting a change, just clone this repository and run:
npm install
npm run devThis will listen for changes and automatically rebuild docs for the example/ project at http://localhost:8888/index.html.
License
By Eric Zhang, released under the MIT license.

