0.1.10 ā€¢ Published 1 year ago

extra-typedoc-theme v0.1.10

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

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.html ā†’ function.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"

npm.io ORG

0.1.10

1 year ago

0.1.8

1 year ago

0.1.7

1 year ago

0.1.9

1 year ago

0.1.4

1 year ago

0.1.3

1 year ago

0.1.6

1 year ago

0.1.5

1 year ago

0.0.10

2 years ago

0.0.11

2 years ago

0.0.12

2 years ago

0.1.0

2 years ago

0.1.2

2 years ago

0.1.1

2 years ago

0.0.9

2 years ago

0.0.8

2 years ago

0.0.7

2 years ago

0.0.6

2 years ago

0.0.5

2 years ago

0.0.4

2 years ago

0.0.3

2 years ago