Merge pull request #52 from nickgros/docusaurus

Author: nickgros

.github/workflows/ci.yml

@@ -24,36 +24,59 @@ jobs:
     - run: npm run cs-check
 
     - name: Build with Netlify badge
-      if: github.ref != 'refs/heads/main'
+      if: github.ref != 'refs/heads/main' && matrix.node-version != '14.x'
       run: npm run build
       env:
         VITE_SHOW_NETLIFY_BADGE: true
         NODE_OPTIONS: --max_old_space_size=4096
+
     - name: Build
-      if: github.ref == 'refs/heads/main'
+      if: github.ref == 'refs/heads/main' && matrix.node-version != '14.x'
       run: npm run build
       env:
         NODE_OPTIONS: --max_old_space_size=4096
 
+    # Docusaurus doesn't support Node 14. These tasks can be removed once Node 14 is EOL (May 2023)
+    - name: Build with Netlify badge (no docs)
+      if: github.ref != 'refs/heads/main' && matrix.node-version == '14.x'
+      run: npx nx run-many --target=build --exclude=docs
+      env:
+        VITE_SHOW_NETLIFY_BADGE: true
+        NODE_OPTIONS: --max_old_space_size=4096
+    - name: Build (no docs)
+      if: github.ref == 'refs/heads/main' && matrix.node-version == '14.x'
+      run: npx nx run-many --target=build --exclude=docs
+      env:
+        NODE_OPTIONS: --max_old_space_size=4096
+
     - if: matrix.node-version == '18.x'
       uses: actions/upload-artifact@v3
       with:
-        name: dist
+        name: playground
         path: packages/playground/dist
+    - if: matrix.node-version == '18.x'
+      uses: actions/upload-artifact@v3
+      with:
+        name: docs
+        path: packages/docs/build
     - run: npm test
-
-  deploy_playground:
+  deploy_playground_and_docs:
     runs-on: ubuntu-latest
     if: github.ref == 'refs/heads/main'
-    name: Deploy playground to GitHub Pages
+    name: Deploy playground and docs to GitHub Pages
     needs: [build]
     steps:
-      - name: Download built files
+      - name: Download built playground
         uses: actions/download-artifact@v3
         with:
           name: dist
           path: dist
-      - name: Deploy playground
+      - name: Download built docs
+        uses: actions/download-artifact@v3
+        with:
+          name: docs
+          path: dist/docs
+      - name: Deploy playground + docs to GitHub Pages
         uses: crazy-max/ghaction-github-pages@v3.1.0
         with:
           keep_history: true
@@ -62,7 +85,7 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-  docs:
+  old_docs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v3

packages/docs/.gitignore

@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

packages/docs/README.md

@@ -0,0 +1,41 @@
+# Website
+
+This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
+
+### Installation
+
+```
+$ yarn
+```
+
+### Local Development
+
+```
+$ yarn start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+### Build
+
+```
+$ yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Deployment
+
+Using SSH:
+
+```
+$ USE_SSH=true yarn deploy
+```
+
+Not using SSH:
+
+```
+$ GIT_USER=<Your GitHub username> yarn deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

packages/docs/babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};

docs/advanced-customization/custom-templates.md renamed to packages/docs/docs/advanced-customization/custom-templates.md

@@ -976,7 +976,7 @@ render((
 
 The `SubmitButton` is already very customizable via the `UISchemaSubmitButtonOptions` capabilities in the `uiSchema` but it can also be fully customized as you see fit.
 > NOTE: However you choose to implement this, making it something other than a `submit` type `button` may result in the `Form` not submitting when pressed.
-> You could also choose to provide your own submit button as the [children prop](https://react-jsonschema-form.readthedocs.io/en/stable/api-reference/form-props#children) of the `Form` should you so choose.
+> You could also choose to provide your own submit button as the [children prop](../api-reference/form-props#children) of the `Form` should you so choose.
 
 ```tsx
 import React from "react";

docs/advanced-customization/custom-themes.md renamed to packages/docs/docs/advanced-customization/custom-themes.md

@@ -4,7 +4,7 @@ Miscellaneous internals of react-jsonschema-form are listed here.
 
 ## JSON Schema supporting status
 
-This component follows [JSON Schema](http://json-schema.org/documentation.html) specs. We currently support JSON Schema-07 by default, but we also support other JSON schema versions through the [custom schema validation](https://react-jsonschema-form.readthedocs.io/en/stable/validation/#custom-schema-validation) feature. Due to the limitation of form widgets, there are some exceptions as follows:
+This component follows [JSON Schema](http://json-schema.org/documentation.html) specs. We currently support JSON Schema-07 by default, but we also support other JSON schema versions through the [custom schema validation](../usage/validation#custom-meta-schema-validation) feature. Due to the limitation of form widgets, there are some exceptions as follows:
 
 * `additionalItems` keyword for arrays
 
@@ -14,15 +14,15 @@ This component follows [JSON Schema](http://json-schema.org/documentation.html)
 
     The `anyOf` and `oneOf` keywords are supported; however, properties declared inside the `anyOf/oneOf` should not overlap with properties "outside" of the `anyOf/oneOf`.
 
-    You can also use `oneOf` with [schema dependencies](https://react-jsonschema-form.readthedocs.io/en/docs/usage/dependencies/#schema-dependencies) to dynamically add schema properties based on input data.
+    You can also use `oneOf` with [schema dependencies](../usage/dependencies#schema-dependencies) to dynamically add schema properties based on input data.
 
     The `allOf` keyword is supported; it uses [json-schema-merge-allof](https://github.com/mokkabonna/json-schema-merge-allof) to merge subschemas to render the final combined schema in the form. When these subschemas are incompatible, though (or if the library has an error merging it), the `allOf` keyword is dropped from the schema.
 
-* `"additionalProperties":false` produces incorrect schemas when used with [schema dependencies](https://react-jsonschema-form.readthedocs.io/en/docs/usage/dependencies/#schema-dependencies). This library does not remove extra properties, which causes validation to fail. It is recommended to avoid setting `"additionalProperties":false` when you use schema dependencies. See [#848](https://github.com/rjsf-team/react-jsonschema-form/issues/848) [#902](https://github.com/rjsf-team/rjsf-team/issues/902) [#992](https://github.com/rjsf-team/rjsf-team/issues/992)
+* `"additionalProperties":false` produces incorrect schemas when used with [schema dependencies](../usage/dependencies#schema-dependencies). This library does not remove extra properties, which causes validation to fail. It is recommended to avoid setting `"additionalProperties":false` when you use schema dependencies. See [#848](https://github.com/rjsf-team/react-jsonschema-form/issues/848) [#902](https://github.com/rjsf-team/rjsf-team/issues/902) [#992](https://github.com/rjsf-team/rjsf-team/issues/992)
 
 ## Handling of schema defaults
 
-This library automatically fills default values defined in the [JSON Schema](http://json-schema.org/documentation.html) as initial values in your form. This also works for complex structures in the schema. If a field has a default defined, it should always appear as default value in form. This also works when using [schema dependencies](https://react-jsonschema-form.readthedocs.io/en/docs/usage/dependencies/#schema-dependencies).
+This library automatically fills default values defined in the [JSON Schema](http://json-schema.org/documentation.html) as initial values in your form. This also works for complex structures in the schema. If a field has a default defined, it should always appear as default value in form. This also works when using [schema dependencies](../usage/dependencies/#schema-dependencies).
 
 Since there is a complex interaction between any supplied original form data and any injected defaults, this library tries to do the injection in a way which keeps the original intention of the original form data.
 

docs/advanced-customization/custom-widgets-fields.md renamed to packages/docs/docs/advanced-customization/custom-widgets-fields.md

@@ -1,3 +1,7 @@
+---
+title: <Form /> Props
+---
+
 # &lt;Form /> props
 
 ## acceptcharset
@@ -26,7 +30,7 @@ The value of this prop will be passed to the `class` [HTML attribute on the form
 
 You can provide custom buttons to your form via the `Form` component's `children`. If no children are provided, by default a `Submit` button will be rendered.
 
-For other ways to modify the default `Submit` button, see both the [Submit Button Options](../uiSchema.md#submitbuttonoptions) and the [SubmitButton Template](../../advanced-customization/custom-templates.md#submitbutton) documentation.
+For other ways to modify the default `Submit` button, see both the [Submit Button Options](./uiSchema.md#submitbuttonoptions) and the [SubmitButton Template](../advanced-customization/custom-templates.md#submitbutton) documentation.
 
 ```tsx
 import { RJSFSchema } from "@rjsf/utils";