typedoc-loader

v5.0.1
A Webpack loader that converts TypeScript to TypeDoc JSON.
Webpack loader TypeScript TypeDoc

typedoc-loader

A Webpack loader that converts TypeScript to TypeDoc JSON.

Usage

module: {
  rules: [{
    test: /\.md$/,
    use: {
      loader: 'typedoc-loader',
      options: {
        // All options are passed to typedoc, except `mode` which is always `file`,
        // and `json` which is always `true`.
        // https://github.com/TypeStrong/typedoc#arguments
      }
    }
  }]
}

See additional documentation on using loaders.

Testing & contributing

Tests are run with Jest:

npm install
npm test

Contributions are welcome! New features or bug fixes must include tests. Try to match existing code style, or better yet, add ESLint or Prettier to this project.

npm i typedoc-loader

Metadata

  • MIT
  • Whatever
  • Andrew Branch
  • released 4/17/2019

Downloads

Maintainers