typedoc 0.5.7

Create api documentations for typescript projects.

Homepage: http://typedoc.org

Platform: npm

Language: HTML

License: Apache-2.0

Keywords: typescript, documentation, generator, gruntplugin

Repository: https://github.com/TypeStrong/TypeDoc

View on registry: https://www.npmjs.com/package/typedoc

Direct download link: https://registry.npmjs.org/typedoc/-/typedoc-0.5.7.tgz

Install: npm install [email protected]


TypeDoc

Documentation generator for TypeScript projects.

Build Status NPM Version Chat on Gitter

Installation

TypeDoc runs on Node.js and is available as an NPM package. You can install TypeDoc in your project's directory as usual:

$ npm install typedoc --save-dev

Like the TypeScript compiler, TypeDoc comes with a binary that can be called from anywhere if you install TypeDoc as a global module. The name of the executable is typedoc.

$ npm install typedoc --global
$ typedoc

Usage

Shell

TypeDoc accepts most of the command line arguments that the TypeScript compiler accepts. One major difference is the fact that one may pass an entire directory instead of individual files to the documentation generator. So in order to create a documentation for an entire project you simply type:

$ typedoc --out path/to/documentation/ path/to/typescript/project/

Important note

Starting with version 0.2, TypeDoc no longer can predict whether files should be treated as modules or whether the project should be compiled into one big namespace. You must specify the mode argument in order to change the behaviour of TypeDoc.

Arguments

  • --out <path/to/documentation/>
    Specifies the location the documentation should be written to.
  • --mode <file|modules>
    Specifies the output mode the project is used to be compiled with.
  • --json <path/to/output.json>
    Specifies the location and file name a json file describing the project is written to. When specified no documentation will be generated.

Source file handling

  • --exclude <pattern>
    Exclude files by the given pattern when a path is provided as source
  • --includeDeclarations
    Turn on parsing of .d.ts declaration files.
  • --externalPattern <pattern>
    Define a pattern for files that should be considered being external.
  • --excludeExternals
    Prevent externally resolved TypeScript files from being documented.
  • --excludePrivate
    Prevent private members from being included in the generated documentation.

TypeScript compiler

  • --module <commonjs, amd, system or umd>
    Specify module code generation: "commonjs", "amd", "system" or "umd".
  • --target <ES3, ES5, or ES6>
    Specify ECMAScript target version: "ES3" (default), "ES5" or "ES6"

Theming

  • --theme <default|minimal|path/to/theme>
    Specify the path to the theme that should be used.
  • --name <Documentation title>
    Set the name of the project that will be used in the header of the template.
  • --readme <path/to/readme|none>
    Path to the readme file that should be displayed on the index page. Pass none to disable the index page and start the documentation on the globals page.
  • --hideGenerator
    Do not print the TypeDoc link at the end of the page.
  • --gaID
    Set the Google Analytics tracking ID and activate tracking code.
  • --gaSite <site>
    Set the site name for Google Analytics. Defaults to auto
  • --entryPoint <fully.qualified.name>
    Specifies the fully qualified name of the root symbol. Defaults to global namespace.

Content

  • --includes <path/to/includes>
    Specifies the location to look for included documents. One may use [[include:FILENAME]] in comments to include documents from this location.

  • --media <path/to/media>
    Specifies the location with media files that should be copied to the output directory. In order to create a link to media files use the pattern media://FILENAME in comments.

Miscellaneous

  • --version
    Display the version number of TypeDoc.
  • --help
    Display a simple cheat sheet.

Webpack

There is a plugin available to run TypeDoc with Webpack created by Microsoft. You can find it on NPM:
https://www.npmjs.com/package/typedoc-webpack-plugin

Gulp

There is a plugin available to run TypeDoc with Gulp created by Rogier Schouten. You can find it on NPM:
https://www.npmjs.org/package/gulp-typedoc/

Grunt

There is a plugin available to run TypeDoc with Grunt created by Bart van der Schoor. You can find it on NPM:
https://www.npmjs.org/package/grunt-typedoc

Plugins

Advanced guides and docs

Visit our homepage for advanced guides and an extensive API documentation:
http://typedoc.org

Contributing

Contributions are welcome and appreciated. You can find TypeDoc on GitHub, feel free to start an issue or create a pull requests:
https://github.com/TypeStrong/typedoc

License

Copyright (c) 2015 Sebastian Lenz.
Licensed under the Apache License 2.0.


Dependencies Requirements Latest Stable Latest Release Licenses
fs-extra ^2.0.0 2.0.0 2.0.0 MIT
handlebars 4.0.5 4.0.6 4.0.6 MIT
highlight.js ^9.0.0 9.9.0 9.9.0 BSD-3-Clause
lodash ^4.13.1 4.17.4 4.17.4 MIT
marked ^0.3.5 0.3.6 0.3.6 MIT
minimatch ^3.0.0 3.0.3 3.0.3 ISC
progress ^1.1.8 1.1.8 1.1.8 MIT
shelljs ^0.7.0 0.7.6 0.7.6 BSD-3-Clause
typedoc-default-themes ^0.4.2 0.4.1 0.4.1 Apache-2.0
typescript 2.1.6 2.2.1 2.3.0-dev.20170226 Apache-2.0
@types/fs-extra 0.0.33 0.0.37 0.0.37 MIT
@types/handlebars ^4.0.31 4.0.31 4.0.29 MIT
@types/highlight.js ^9.1.8 9.1.9 9.1.9 MIT
@types/lodash ^4.14.37 4.14.46 4.14.46 MIT
@types/marked 0.0.28 0.0.28 0.0.28 MIT
@types/minimatch ^2.0.29 2.0.29 2.0.29 MIT
@types/shelljs ^0.3.32 0.7.0 0.7.0 MIT
Explore the resolved dependency tree for typedoc 0.5.7
Development Dependencies Requirements Latest Stable Latest Release Licenses
grunt ^1.0.1 1.0.1 1.0.1 MIT
grunt-cli ^1.2.0 1.2.0 1.2.0 MIT
grunt-contrib-clean ^1.0.0 1.0.0 1.0.0 MIT
grunt-contrib-watch ^1.0.0 1.0.0 1.0.0 MIT
grunt-mocha-istanbul ^5.0.1 5.0.2 5.0.2 MIT
grunt-string-replace ^1.2.0 2.7.1 2.7.1 MIT
grunt-ts ^5.5.1 5.5.1 6.0.0-beta.6 MIT
istanbul ^0.4.1 0.4.5 1.1.0-alpha.1 BSD-3-Clause
mocha ^3.0.2 3.2.0 3.2.0 MIT
Explore the resolved development dependency tree for typedoc 0.5.7

Releases

  • 0.5.7 - February 17, 2017 18:07
  • 0.5.6 - February 14, 2017 23:41
  • 0.5.5 - January 13, 2017 02:22
  • 0.5.4 - January 13, 2017 00:37
  • 0.5.3 - December 27, 2016 22:21
  • 0.5.2 - December 27, 2016 21:39
  • 0.5.1 - October 28, 2016 17:28
  • 0.5.0 - October 11, 2016 20:55
  • 0.4.5 - August 18, 2016 10:49
  • 0.4.4 - June 20, 2016 16:04
See all 42 releases

Project Statistics

SourceRank 21
Dependencies 17
Dependent projects 837
Dependent repositories 2.3K
Total releases 42
Latest release
First release
Stars 842
Forks 158
Watchers 45
Contributors 47
Repo Size: 5.44 MB

Top Contributors See all

Sebastian Lenz Blake Embrey Greenkeeper André Werlang Jason Cheatham Kamran Ayub Chris Thielen Jeremy Danyow Chris White Tobiasz Cudnik Micha Reiser jkelvie Andrew Bradley Bart van der Schoor Pascal Berger Tom Coleman Rob Moran Marcel Jackwerth Casey Howard Louis-Dominique Dubeau

Something wrong with this page? Make a suggestion

Export .ABOUT file for this library

Last synced: 2017-02-17 18:26:17 UTC

Login to resync this project