Registry / documentation / docusaurus-json-schema-plugin

docusaurus-json-schema-plugin

library1.15.1jsnpmunverified

A Docusaurus plugin (v1.15.1, active development) that adds a JSON Schema viewer/editor React component to Docusaurus documentation sites. Supports JSON Schema drafts 07, 2019-09, and 2020-12. Integrates with Docusaurus 3.x, includes i18n support via `write-translations`, and ships TypeScript types. Differentiators include a human-friendly UI for schema exploration and ease of integration compared to custom solutions.

documentation

npm install docusaurus-json-schema-plugin

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · DOCUSAURUS-JSON-SC

docusaurus-json-schema-plugin

documentationjavascriptv1.15.1

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

default

✓ import plugin from 'docusaurus-json-schema-plugin'

✗ const plugin = require('docusaurus-json-schema-plugin')

Plugin is exported as default; CommonJS require is supported but TypeScript types prefer ESM import.

JsonSchemaViewer

✓ import { JsonSchemaViewer } from 'docusaurus-json-schema-plugin'

✗ import JsonSchemaViewer from 'docusaurus-json-schema-plugin'

Component is a named export, not default.

JsonSchemaEditor

✓ import { JsonSchemaEditor } from 'docusaurus-json-schema-plugin'

Available from v1.0.0; ESM only in recent versions.

Registers the JSON Schema plugin in a Docusaurus config, pointing to a local schema file.

// docusaurus.config.js const plugin = require('docusaurus-json-schema-plugin'); module.exports = { plugins: [ [ plugin, { id: 'json-schema', schemas: [ { id: 'my-schema', label: 'My Schema', file: './schemas/my-schema.json', }, ], }, ], ], };

Debug

Known issues

breakingPlugin now requires Docusaurus v3.10.1+. Older versions (e.g., v1.12.x) supported Docusaurus v2.

fix

Upgrade to Docusaurus >=3.10.1 or use the last v1.12.x version with Docusaurus v2.

affects: >=1.13.0

deprecatedThe `schema` prop directly on components is deprecated; use the plugin config instead.

fix

Define schemas in docusaurus.config.js under the plugin options.

affects: >=1.10.0

gotchaThe plugin installs both viewer and editor by default; to disable one, you must explicitly set `enableEditor: false` or `enableViewer: false`.

fix

Add `enableEditor: false` (or `enableViewer: false`) to plugin options if not needed.

affects: >=1.0.0

breakingESM-only exports since v1.13.0; CommonJS require may fail in some Node environments.

fix

Use dynamic import or switch to ESM in your Docusaurus config (e.g., `module.exports = async () => {...}`).

affects: >=1.13.0

Errors

Common errors & fixes

Error: Cannot find module 'docusaurus-json-schema-plugin'

Plugin not installed or installed in wrong directory.

fix

Run `npm install docusaurus-json-schema-plugin --save` in your Docusaurus project root.

TypeError: plugin is not a function

Importing the plugin incorrectly (e.g., using default import when not needed) or using an older version.

fix

Ensure you use the correct import: `const plugin = require('docusaurus-json-schema-plugin');` or `import plugin from 'docusaurus-json-schema-plugin';`.

Error: Invalid plugin options. "schemas" must be an array.

The `schemas` option is missing or not an array in the plugin configuration.

fix

Define schemas as an array of objects, each with `id`, `label`, and `file` (or `url`).

Upgrade

Version history

1.15.1latest on npm

Audit

Dependencies

@docusaurus/corerequiredCore Docusaurus dependency; plugin cannot function without it.

@docusaurus/theme-classicrequiredRequired for theme integration and component styling.

reactrequiredReact required for rendering components.

Agent activity

41 hits · last 30 days

node

Bingbot

OpenAI (training)

Resources

githubhttps://github.com/jy95/docusaurus-json-schema-plugin ↗

packagedocusaurus-json-schema-plugin ↗

homepagehttps://jy95.github.io/docusaurus-json-schema-plugin/ ↗