npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@paztis/typedoc

v0.1.8

Published

Create api documentation for TypeScript projects.

Downloads

61

Readme

TypeDoc

Documentation generator for TypeScript projects.

Build Status npm version

Documentation

Visit our website for more complete documentation and example API documentation: https://typedoc.org.

There you can find an installation guide explaining how to use typedoc from the cli, webpack, grunt, or gulp. There are additional guides explaining how to extend typedoc using plugins and themes.

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 @paztis/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 @paztis/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/

Arguments

For a complete list of the command line arguments run typedoc --help or visit our website.

  • --out <path/to/documentation/> Specifies the location the documentation should be written to. Defaults to ./docs
  • --mode <file|modules|library> Specifies the output mode the project is used to be compiled with. See the documentation for a comparison of each mode.
  • --options Specify a json option file that should be loaded. If not specified TypeDoc will look for 'typedoc.json' in the current directory.
  • --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.
  • --ignoreCompilerErrors Allows TypeDoc to still generate documentation pages even after the compiler has returned errors.

Source file handling

  • --exclude <pattern> Exclude files by the given pattern when a path is provided as source. Supports standard minimatch patterns (see #170)
  • --includeDeclarations Turn on parsing of .d.ts declaration files.
  • --excludeExternals Do not document external files, highly recommended if turning on --includeDeclarations.

TypeScript compiler

  • --tsconfig <path/to/tsconfig.json> Specify a typescript config file that should be loaded. If not specified TypeDoc will look for 'tsconfig.json' in the current directory.

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.

Miscellaneous

  • --version Display the version number of TypeDoc.
  • --help Display all TypeDoc options.

Contributing

This project is maintained by a community of developers. 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/paztis/typedoc

For more information, read the contribution guide.

License

Copyright (c) 2015 Sebastian Lenz. Copyright (c) 2016-2018 TypeDoc Contributors. Licensed under the Apache License 2.0.