https://github.com/gera2ld/gatsby-source-jsdoc

Gatsby source plugin which uses jsdoc-api to generate JavaScript documentation
https://github.com/gera2ld/gatsby-source-jsdoc

Last synced: about 1 year ago
JSON representation

Gatsby source plugin which uses jsdoc-api to generate JavaScript documentation

• Host: GitHub
• URL: https://github.com/gera2ld/gatsby-source-jsdoc
• Owner: gera2ld
• Created: 2018-11-09T13:34:08.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2019-11-27T17:46:15.000Z (over 6 years ago)
• Last Synced: 2025-02-15T20:52:56.940Z (over 1 year ago)
• Language: JavaScript
• Size: 30.3 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# gatsby-source-jsdoc

[![NPM](https://img.shields.io/npm/v/gatsby-source-jsdoc.svg)](https://npm.im/gatsby-source-jsdoc)

This plugin requires an instance of [gatsby-source-filesystem](https://www.gatsbyjs.org/packages/gatsby-source-filesystem/) to provide the source files. Then `gatsby-source-jsdoc` will generate Markdown files for [gatsby-transformer-remark](https://www.gatsbyjs.org/packages/gatsby-transformer-remark/) to process.

## Install

```sh

$ 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.

```javascript

{

  plugins: [

    {

      resolve: 'gatsby-source-filesystem',

      options: {

        name: 'source',

        path: `${__dirname}/src/`,

      },

    },

    {

      resolve: 'gatsby-source-jsdoc',

      options: {

        sourceDir: `${__dirname}/src/`,

      },

    },

  ],

}

```