0.1.0 • Published 2 years ago
@gjsify/typedoc-theme v0.1.0
TypeDoc Gjsify Theme
A compatible TypeDoc theme build for Gjsify.
Install
npm install @gjsify/typedoc-plugin-remote-search @gjsify/typedoc-theme --save-dev
Usage
typedoc --plugin @gjsify/typedoc-plugin-remote-search --theme gjsify --out docs src/index.ts
# Wait until documentation generation is done
typedoc-server serve ./doc
Development
This theme was developed specifically for the requirements of Gjsify, if there is a need we are happy to extend the theme for general use. For example with options to replace the logo. We therefore also gladly accept pull requests, but this is not a must, you are also welcome to just fork the theme to fit your own needs.
This package contains everything needed to build the theme for Typedoc, but the client side javascript code is developed in a separate package called @gjsify/typedoc-theme-client.
0.1.0
2 years ago