This package has been deprecated

Author message:

Was not worth keeping up with the vulnerabilities and churn in TypeDoc; if you want to consume TypeDoc in Webpack, I suggest you write an ad-hoc loader in your own project.

typedoc-loader

5.0.1 • Public • Published

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.

Package Sidebar

Install

npm i typedoc-loader

Weekly Downloads

1

Version

5.0.1

License

MIT

Unpacked Size

4.87 kB

Total Files

10

Last publish

Collaborators

  • andrewbranch