Skip to content

nodef/extra-typedoc-theme

Repository files navigation

TypeDoc theme for extra-* packages.
📦 Node.js, 📜 Files.

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.htmlfunction.html) in order to enable simple linking to generated HTML documentation.

Stability: Experimental.


## 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"



ORG