Skip to content

Commit f430e0d

Browse files
committed
Add schemas and poc doc using docusaurus-json-schema-plugin
1 parent c7a0558 commit f430e0d

File tree

10 files changed

+4181
-0
lines changed

10 files changed

+4181
-0
lines changed

docs/schemas/builder-schema.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
import CodeBlock from '@theme/CodeBlock';
2+
import Schema from '@site/static/schemas/Builder.schema.json';
3+
import JSONSchemaViewer from '@theme/JSONSchemaViewer';
4+
5+
# Builder schema
6+
7+
<JSONSchemaViewer schema={Schema} />

docs/schemas/index.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
id: schemas-poc
3+
title: PoC of schema doc using docusaurus-json-schema-plugin
4+
---
5+
6+
:::warning
7+
These are generated using an old version of docusaurus-json-schema-plugin.
8+
:::
9+
10+
- [Builder schema](builder-schema.mdx)
11+
- [ManifestDefinition schema](manifest-def-schema.mdx)
12+
- [Reader schema](reader-schema.mdx)
13+
- [Settings schema](settings-schema.mdx)
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
import CodeBlock from '@theme/CodeBlock';
2+
import Schema from '@site/static/schemas/ManifestDefinition.schema.json';
3+
import JSONSchemaViewer from '@theme/JSONSchemaViewer';
4+
5+
# ManifestDefinition schema
6+
7+
<JSONSchemaViewer schema={Schema} />

docs/schemas/reader-schema.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
import CodeBlock from '@theme/CodeBlock';
2+
import Schema from '@site/static/schemas/Reader.schema.json';
3+
import JSONSchemaViewer from '@theme/JSONSchemaViewer';
4+
5+
# Reader schema
6+
7+
<JSONSchemaViewer schema={Schema} />

docs/schemas/settings-schema.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
import CodeBlock from '@theme/CodeBlock';
2+
import Schema from '@site/static/schemas/Settings.schema.json';
3+
import JSONSchemaViewer from '@theme/JSONSchemaViewer';
4+
5+
# Settings schema
6+
7+
<JSONSchemaViewer schema={Schema} />

sidebars.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@ const sidebars = {
66
type: 'doc',
77
id: 'introduction',
88
},
9+
{
10+
type: 'doc',
11+
label: 'Schema doc PoC',
12+
id: 'schemas/schemas-poc',
13+
},
914
{
1015
type: 'category',
1116
label: 'Getting started',

0 commit comments

Comments
 (0)