feat(:sparkles:) Adding support for global storage

Author: atomicpages

.github/actions/on_push.yml

@@ -0,0 +1,19 @@
+on: [push, pull_request]
+name: Build PR & Push
+jobs:
+    build:
+        runs-on: ubuntu-latest
+        strategy:
+            matrix:
+                node-version: [12.x, 14.x]
+        steps:
+            - uses: actions/checkout@v1
+            - name: Use Node.js ${{ matrix.node-version }}
+              uses: actions/setup-node@v1
+              with:
+                  node-version: ${{ matrix.node-version }}
+            - name: npm install, lint, and build
+              run: |
+                  npm i
+                  npm run lint
+                  npm run build

.github/actions/on_release.yml

@@ -0,0 +1,19 @@
+name: Release
+on:
+    release:
+        types: [released]
+jobs:
+    publish:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v1
+            - uses: actions/setup-node@v1
+              with:
+                  node-version: 12
+                  registry-url: https://registry.npmjs.org/
+            - name: npm install
+              run: npm i
+            - name: publish
+              run: npm publish
+              env:
+                  NODE_AUTH_TOKEN: ${{secrets.npm_token}}

README.md

@@ -21,15 +21,28 @@ module.exports = {
         [
             'docusaurus-plugin-react-docgen',
             {
-                // pass in a single string or an array
-                src: [
-                    'path/to/**/*.tsx',
-                    '!path/to/**/*test.*',
-                ]
-            }
-        ]
-    ]
-}
+                // pass in a single string or an array of strings
+                src: ['path/to/**/*.tsx', '!path/to/**/*test.*'],
+                route: {
+                    path: '/docs/api',
+                    component: require.resolve('./src/components/MyDataHandler.js'),
+                    exact: true,
+                },
+            },
+        ],
+    ],
+};
 ```
 
 Any pattern supported by [`fast-glob`](https://github.com/mrmlnc/fast-glob) is allowed here (including negations)
+
+## Options
+
+| Name            | Type                                                                                                             | Required | Description                                                                                                                                                |
+| --------------- | ---------------------------------------------------------------------------------------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `src`           | `string` \| `string[]`                                                                                           | Yes      | Tell `react-docgen` where to ook for source files. Use relative, absolute, and/or globbing syntax                                                          |
+| `global`        | `boolean`                                                                                                        | No       | Store results so they're [globally accessible](https://v2.docusaurus.io/docs/docusaurus-core#useplugindatapluginname-string-pluginid-string) in docusaurus |
+| `route`         | [`RouteConfig`](https://v2.docusaurus.io/docs/lifecycle-apis#actions)                                            | No       | Makes docgen results accessible at the specified URL. Note `modules` cannot be overridden.                                                                 |
+| `docgen`        | [docgen config](https://github.com/reactjs/react-docgen#source)                                                  | No       | Pass custom resolvers and handlers to `react-docgen`                                                                                                       |
+| `parserOptions` | [babel parser options](https://github.com/reactjs/react-docgen#-parseroptions)                                   | No       | Pass custom options to `@babel/parser`                                                                                                                     |
+| `babel`         | [docgen options](https://github.com/reactjs/react-docgen#-babelrc-babelrcroots-root-rootmode-configfile-envname) | No       | Pass specific options to `@babel/parse` that aids in resolving the correct babel config file                                                               |