Gatsby-transformer-react-docgen NPM

gatsby-transformer-react-docgen

Parses inline component-documentation using react-docgen.

Install

npm install gatsby-transformer-react-docgen

Usage

Add a plugin-entry to your gatsby-config.js

module.exports = {
  plugins: [`gatsby-transformer-react-docgen`],
}

For custom resolvers or handlers, all config options are passed directly to react-docgen. In addition any custom handlers are passed the component file Node object as their last argument for more Gatsby specific handler behavior.

module.exports = {
  plugins: [
    {
      resolve: "gatsby-transformer-react-docgen",
      options: {
        resolver: require("./custom-resolver"),
      },
    },
  ],
}

File parsing and babel configs

By default, your local .babelrc will be used to determine how to parse source files. Don't worry if you don't have a local babel config and are using Gatsby's default settings! If there isn't any config react-docgen will use it's own, permissive parsing options.

In the case of more complex sites with local custom configs, such as in a monorepo, you may have to tell babel (via react-docgen), how to properly resolve your local babel config. See the react-docgen documentation for more details.

module.exports = {
  plugins: [
    {
      resolve: "gatsby-transformer-react-docgen",
      options: {
        babelrcRoots: ["../packages/*"],
      },
    },
  ],
}

You'll also need to include a source-plugin, such as gatsby-source-filesystem, so that the transformer has access to source data.

Note: that at least one of your React Components must have PropTypes defined.

How to query

An example graphql query to get nodes:

{
  allComponentMetadata {
    edges {
      node {
        displayName
        description
        props {
          name
          type
          required
        }
      }
    }
  }
}

gatsby gatsby-plugin react react-docgen

@babel/code-frame @babel/runtime @babel/types ast-types common-tags react-docgen

@everything-registry/sub-chunk-1725 @breakaway/react-docs throwaway-dsx wizard-ui-docs @infinitebrahmanuniverse/nolb-gatsby-t @redallen-patternfly/react-docs @pauliescanlon/gatsby-plugin-prop-shop @nyctalope/doc @swiper/docs @zalastax/nolb-gatsby-t gatsby-theme-datocms gatsby-theme-designql gatsby-theme-jules gatsby-theme-mdx-suite gatsby-theme-mdx-suite-docs dsx react-dsx

3 months ago

3 months ago

4 months ago

5 months ago

5 months ago

8 months ago

12 months ago

11 months ago

12 months ago

11 months ago

11 months ago

9 months ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

7.14.0-alpha-transformer-json.26

2 years ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

8.0.0-alpha-v5.d20221010t183635.51

2 years ago

8.1.0-next.0

1 year ago

8.0.0-alpha-v5.d20221005t111511.35

2 years ago

8.0.0-alpha-v5.d20221007t081809.41

2 years ago

1 year ago

1 year ago

2 years ago

2 years ago

1 year ago

2 years ago

1 year ago

8.0.0-alpha-v5.d20221012t101120.57

2 years ago

8.0.0-alpha-drupal-proxyurl.14

1 year ago

8.0.0

1 year ago

8.3.0-next.0

1 year ago

7.23.0-next.0

2 years ago

7.23.0-alpha-9689ff.25

2 years ago

7.23.0-alpha-v5.26

2 years ago

7.23.0-alpha-preview-gh-api.26

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

7.23.0-alpha-a5-peer.70

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

7.15.0-alpha-wp-image-cdn-auth.48

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

7.18.0-alpha-drupal-self-reference.18

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

7.6.0-alpha-ts-jit.60

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

7.8.0-alpha-image-service.25

2 years ago

7.8.0-alpha-image-service.24

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

7.7.0-alpha-image-service.52

2 years ago

2 years ago

2 years ago

2 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

7.0.0-alpha-9689ff.13

3 years ago

7.0.0-next.1

3 years ago

7.0.0-next.0

3 years ago

6.14.0-alpha-qe-sm.46

3 years ago

7.0.0-alpha-9689ff.36

3 years ago

7.0.0-alpha-9689ff.34

3 years ago

7.0.0-alpha-9689ff.24

3 years ago

7.0.0-alpha-9689ff.22

3 years ago

7.0.0-alpha-9689ff.17

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

7.0.0-alpha-9689ff.27

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

5.1.3-unifiedroutes.76

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

1.0.0-beta.7-alpha.594d939c

7 years ago

1.0.0-beta.7-alpha.7dc2afa2

7 years ago

1.0.0-beta.7-alpha.60d2ce84

7 years ago

1.0.0-beta.6-alpha.320adb17

7 years ago

1.0.0-beta.6

7 years ago

1.0.0-beta.5-alpha.dfde8a10

7 years ago

1.0.0-beta.5-alpha.c16c2913

7 years ago

1.0.0-beta.5-alpha.08bddd92

7 years ago

1.0.0-beta.5-alpha.fb30fcd6

7 years ago

1.0.0-beta.5-alpha.1a65ba72

7 years ago

1.0.0-beta.5-alpha.c64a932e

7 years ago

1.0.0-beta.4-alpha.83182d4c

7 years ago

1.0.0-beta.4

7 years ago

1.0.0-beta.3-alpha.9451bcd6

7 years ago

1.0.0-beta.3-alpha.590c01b7

7 years ago

1.0.0-beta.3-alpha.a694e4ac

7 years ago

1.0.0-beta.3-alpha.15f49df0

7 years ago

1.0.0-beta.3-alpha.1cb4cf8b

7 years ago

1.0.0-beta.3-alpha.404a27c8

7 years ago

1.0.0-beta.2-alpha.38d760b4

7 years ago

1.0.0-beta.2-alpha.a1195641

7 years ago

1.0.0-beta.2-alpha.4bef9d1e

7 years ago

1.0.0-beta.1-alpha.82c23a65

7 years ago

1.0.0-beta.1

7 years ago

1.0.0-alpha.22-alpha.18f02e94

7 years ago

1.0.0-alpha.22-alpha.2d2aa0ef

7 years ago

1.0.0-alpha.22-alpha.96b0b727

7 years ago

1.0.0-alpha.22-alpha.0be09b66

7 years ago

1.0.0-alpha.22-alpha.acbc22e8

7 years ago

1.0.0-alpha.22-alpha.19f7c727

7 years ago

1.0.0-alpha.22

7 years ago

1.0.0-alpha19-alpha.0ae0ee2a

7 years ago

1.0.0-alpha19-alpha.dcf76508

7 years ago

1.0.0-alpha19-alpha.62172e76

7 years ago

1.0.0-alpha19-alpha.3c6183a4

7 years ago

1.0.0-alpha19-alpha.a2f3e881

7 years ago

1.0.0-alpha19-alpha.81f2510a

7 years ago

1.0.0-alpha19

7 years ago

1.0.0-alpha17

7 years ago

1.0.0-alpha16-alpha.4482ff94

7 years ago

1.0.0-alpha16-alpha.7b3bcd50

7 years ago

1.0.0-alpha16-alpha.d918ccdc

7 years ago

1.0.0-alpha16-alpha.102adc51

7 years ago

1.0.0-alpha16-alpha.a48b771d

7 years ago

1.0.0-alpha16-alpha.b47e49cb

7 years ago

1.0.0-alpha16-alpha.0e39282b

7 years ago

1.0.0-alpha16-alpha.c28a693a

7 years ago

1.0.0-alpha16

7 years ago

1.0.0-alpha15-alpha.4784b06f

7 years ago

1.0.0-alpha15-alpha.330d917d

7 years ago

1.0.0-alpha15-alpha.94fac7a9

7 years ago

1.0.0-alpha15-alpha.14012332

7 years ago

1.0.0-alpha15-alpha.6ffaa855

7 years ago

1.0.0-alpha15-alpha.336b6aa8

7 years ago

1.0.0-alpha15-alpha.62fcc2e1

7 years ago

1.0.0-alpha15-alpha.11f194aa

7 years ago

1.0.0-alpha15-alpha.7211d781

7 years ago

1.0.0-alpha15-alpha.17ca92e9

7 years ago

1.0.0-alpha15-alpha.6c40594a

7 years ago

1.0.0-alpha15

7 years ago

1.0.0-alpha14-alpha.ac7022a4

7 years ago

1.0.0-alpha14-alpha.6611f24e

7 years ago

1.0.0-alpha14-alpha.a4a50ee4

7 years ago

1.0.0-alpha14-alpha.1ebda6e4

7 years ago

1.0.0-alpha14-alpha.42f0e16a

7 years ago

1.0.0-alpha14-alpha.48e2735c

7 years ago

1.0.0-alpha14-alpha.5f9232df

7 years ago

1.0.0-alpha14-alpha.e5097827

7 years ago

1.0.0-alpha14-alpha.3145bea2

7 years ago

1.0.0-alpha14

7 years ago

1.0.0-alpha13-alpha.43a3774e

7 years ago

1.0.0-alpha13-alpha.e4457d15

7 years ago

1.0.0-alpha13-alpha.435e0178

7 years ago