Skip to content
This repository was archived by the owner on Jun 15, 2019. It is now read-only.

andrewbranch/typedoc-loader

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

34 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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.

About

A Webpack loader that emits TypeDoc JSON from TypeScript input.

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors