Docusaurus component pack

This pack imports the original Docusaurus Classic 3.10.2 components: Tabs, TabItem, Admonition, Details, CodeBlock, and ThemedImage. It provides the framework context they need inside Open Knowledge and keeps their styles scoped to the pack. The gallery shows every component.

Install the alpha

corepack pnpm add @inkeep/open-knowledge-components-docusaurus@alpha

In an OpenKnowledge Desktop build with component-pack support, open Settings → This project → Integrations → Components, add node_modules/@inkeep/open-knowledge-components-docusaurus, then trust and enable it. The npm package includes the generated runtime and styles, so no local build is needed.

To develop the pack from this repository, install dependencies from the OpenKnowledge workspace root and run corepack pnpm --dir examples/component-packs/docusaurus build. Rebuild after source or dependency changes. See the pack overview for all packages and the Changesets release workflow.

Components

| Component | Inputs | | --- | --- | | Tabs | defaultValue, block, structured values, TabItem children | | TabItem | value, label, default, editable children | | Admonition | type, title, editable children | | Details | summary, initial open, editable children | | CodeBlock | code, language, title, showLineNumbers, metastring | | ThemedImage | sources={{light, dark}}, alt, width, height |

The property panel exposes primitive inputs. Use MDX source for objects and arrays. CodeBlock passes its code prop to the upstream component as text children. Tabs keep their panels mounted so their content remains editable. The editor's light or dark appearance controls the pack theme.

Build and maintenance

build.mjs resolves Docusaurus's theme imports and generated configuration, then bundles the original components and their CSS into dist/. runtime.tsx supplies upstream framework providers and the editor-facing props. The pack does not copy component implementations, icons, or CSS module class maps.

CSS comes from the pinned Docusaurus packages and Infima. The build scopes it to .ok-docusaurus, excluding editor controls and other packs. editor.css adjusts spacing around editable content. The pack's LICENSE file preserves upstream MIT attribution.

After a dependency update, rebuild and run the pack typecheck, component DOM tests, compiler tests, and desktop gallery smoke test. These checks exercise upstream rendering, editor content, interactions, theme changes, and style isolation.

Limits

The pack renders components; it does not run a documentation site. Site navigation, generated documentation data, custom site configuration, plugins, and Docusaurus Markdown preprocessing are outside its scope. Use JSX Admonition components instead of :::note directives. Tab selection remains local to each group and does not change the editor URL or persist across projects.