See what's launched

The next gen Gatsby is here Performance, developer velocity, and scaling to meet Enterprise needs - See what’s launched

Sign Up for Free
Community Plugin
View plugin on GitHub



This plugin requires an instance of gatsby-source-filesystem to provide the source files. Then gatsby-source-jsdoc will generate Markdown files for gatsby-transformer-remark to process.


$ npm install --save gatsby-source-jsdoc

How to use

Add the plugin to your gatsby-config.js and ensure sourceDir is pointed to the directory of your JavaScript source files.

  plugins: [
      resolve: 'gatsby-source-filesystem',
      options: {
        name: 'source',
        path: `${__dirname}/src/`,
      resolve: 'gatsby-source-jsdoc',
      options: {
        sourceDir: `${__dirname}/src/`,
© 2022 Gatsby, Inc.