Neo theme for TypeDoc
This plugin contains a new theme for TypeDoc which focuses on improved readability and navigation.
Additionally, it extends Typedoc with additional options for a richer user experience.
Visit http://typedoc.org/ to learn more about TypeDoc.
Build the theme by running
After you install the module, you can use this theme in a build by running:
typedoc --theme ./node_modules/typedoc-neo-theme/bin/default
Build the plugin by running
This plugin adds additional options that can be placed in your
You may want to specify additional links to appear in your header that don't point to reference documentation but related documentation for your platform.
The left-hand side is a global navigation. This can be auto-generated by the Typedoc engine and
theme, or it can be manually specified by including an object in your options. You provide a custom
navigation with links that point to
Not all of the files in the reference documentation may be useful for developers. You can select
certain pages to be high priority. These will retain the icon, along with displaying a subtitle and
a kind (like
interface). Items not included will be deprioritized, with smaller text.
Link to source
You can set up links to your source code under each property in the documentation.
For a particular file and line, this can take you to a valid GitHub source for the Actions on Google Node.js project.
Licensed under the Apache License 2.0.