Skip to main content
View plugin on GitHub
See starters using this

gatsby-source-typedoc

build status

A Gatsby plugin that executes Typedoc against TypeScript source files to create GraphQL nodes that contain the TypeDoc generated data structure

Example Usage

# Install the plugin
npm install gatsby-source-typedoc
# Install typedoc as a peer dependency
npm install typedoc -D

In your gatsby-config.js:

module.exports = {
  plugins: [
    {
      resolve: "gatsby-source-typedoc",
      options: {

        // Array of Typescript files to
        // include
        src: [
          `${__dirname}/path/to/index.ts`
        ],

        // Options passed to Typedoc Application
        // Usually corresponds to CLI args directly
        typedoc: {
          target: "es5",
          mode: "modules",
          tsconfig: `${__dirname}/path/to/tsconfig.json`
        }
      }
    }
  ]
};

In GraphQL now you may do:

{
  typedoc {
    id
    source {
      id
      kind
      name
    }
    internal {
      content
    }
  }
}

The typedoc.internal.content field contains the generated JSON you can use to parse and use in your app. You can optionally use GraphQL to go into the typedoc.source fields but due to the recursive nature of the data structure, this may be more annoying than useful.

How is this being used?

We are using this plugin on excaliburjs.github.io to let us link to symbols dynamically in our documentation.

In theory, you could use this to create an entire Gatsby site for your Typedoc project.

Contributing

I welcome all contributions. Releases are automated through Travis CI.


Docs
Tutorials
Plugins
Blog
Showcase