@aeei/docusaurus-theme

A shadcn Base Nova theme for Docusaurus docs.

Features

• shadcn Base Nova components backed only by Base UI
• responsive navbar, collapsible sidebar, table of contents, paginator, and compact footer
• Markdown, GFM, MDX, admonitions, tabs, code blocks, and Mermaid
• semantic light/dark tokens owned by the consuming site
• Lucide icons and accessible keyboard/focus behavior
• precompiled theme CSS; consumers do not configure Tailwind
• optional Docusaurus Algolia DocSearch styling

Quick start

Install the theme alongside Docusaurus classic:

npm install @aeei/docusaurus-theme \
  @docusaurus/core @docusaurus/plugin-content-docs \
  @docusaurus/preset-classic @docusaurus/theme-common

Register it after the classic preset:

// docusaurus.config.ts
import type { Config } from "@docusaurus/types";

const config: Config = {
  presets: ["classic"],
  themes: ["@aeei/docusaurus-theme"],
};

export default config;

The theme consumes semantic CSS variables rather than shipping brand values. Start from examples/docs-starter/src/css/tokens.css, then edit values in your own site.

Markdown and Mermaid

The starter demonstrates the supported authoring surface:

• Markdown and GFM
• MDX components
• Mermaid diagrams

For Mermaid, install the official Docusaurus theme and enable it:

npm install @docusaurus/theme-mermaid @mermaid-js/layout-elk

const config = {
  markdown: { mermaid: true },
  themes: ["@docusaurus/theme-mermaid", "@aeei/docusaurus-theme"],
};

Starter

examples/docs-starter is both the live demo source and a copyable docs-first starter. Routine authors edit:

docs/**/*.md
docs/**/*.mdx
static/**

Navigation is generated from the docs filesystem. Use front matter such as sidebar_position when ordering is needed.

Development

yarn install
yarn workspace @aeei/docusaurus-theme build
yarn workspace @aeei/docs-starter start

Production checks:

yarn workspace @aeei/docusaurus-theme build
yarn workspace @aeei/docs-starter build

The project uses OpenSpec. Current launch artifacts live in openspec/changes/launch-docs-theme.

Search

The first release does not reuse the upstream project's Algolia credentials. Search activates only after this site's own DocSearch application provides ALGOLIA_APP_ID, ALGOLIA_SEARCH_API_KEY, and ALGOLIA_INDEX_NAME. Admin keys are never accepted by the frontend.

Roadmap

The core package is docs-only. OpenAPI rendering may return later as an optional @aeei/docusaurus-theme-openapi addon rather than adding API dependencies to every docs site.

Attribution

This repository is a modified fork of PaloAltoNetworks/docusaurus-openapi-docs. It is maintained independently and is not an official Palo Alto Networks project.

See THIRD_PARTY_NOTICES.md and LICENSES/ for Docusaurus, shadcn/ui, Base UI, Lucide, Mermaid, and upstream notices.

License

MIT. Existing upstream copyright and permission notices are preserved.