⚠ This page is served via a proxy. Original site: https://github.com
This service does not collect credentials or authentication data.
Skip to content

docs: support Mermaid diagrams #54

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pkosiec wants to merge 2 commits into
base: main
Choose a base branch
from
+818 −3
Open

docs: support Mermaid diagrams #54

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2e6a4e5
docs: support Mermaid diagrams
pkosiec Jan 9, 2026
cdd3ba3
chore: rebuild `appkit-ui` styles when running docs dev mode
pkosiec Jan 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions docs/docusaurus.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,25 @@ const config: Config = {
theme: prismThemes.vsLight,
darkTheme: prismThemes.vsDark,
},
mermaid: {
theme: { light: "base", dark: "base" },
options: {
themeVariables: {
// Light mode colors (bluish) - matches Docusaurus theme
primaryColor: "#e3f2fd", // Light blue background
primaryTextColor: "#1b3139", // Dark text from custom.css
primaryBorderColor: "#2272b4", // Primary blue border
lineColor: "#2272b4", // Connection lines
secondaryColor: "#bbdefb", // Secondary elements
tertiaryColor: "#f5f5f5", // Tertiary elements
},
},
},
} satisfies Preset.ThemeConfig,
markdown: {
mermaid: true,
},
themes: ["@docusaurus/theme-mermaid"],
};

export default config;
8 changes: 5 additions & 3 deletions docs/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,11 @@
"version": "0.1.0",
"private": true,
"scripts": {
"build-appkit-ui-styles": "tsx scripts/build-appkit-ui-styles.ts",
"docusaurus": "docusaurus",
"dev": "pnpm run generate-component-docs && docusaurus start --no-open",
"build": "pnpm run build-appkit-ui-styles && pnpm run generate-component-docs && docusaurus build",
"dev": "pnpm run gen && docusaurus start --no-open",
"build": "pnpm run gen && docusaurus build",
"gen": "pnpm run build-appkit-ui-styles && pnpm run generate-component-docs",
"build-appkit-ui-styles": "tsx scripts/build-appkit-ui-styles.ts",
"generate-component-docs": "tsx ../tools/generate-component-mdx.ts",
"swizzle": "docusaurus swizzle",
"deploy": "docusaurus deploy",
Expand All @@ -21,6 +22,7 @@
"@databricks/appkit-ui": "workspace:*",
"@docusaurus/core": "3.9.2",
"@docusaurus/preset-classic": "3.9.2",
"@docusaurus/theme-mermaid": "^3.9.2",
"@mdx-js/react": "^3.0.0",
"@tailwindcss/postcss": "^4.1.18",
"clsx": "^2.0.0",
Expand Down
Loading