Skip to content

Add mermaid diagram support and powershell/bash syntax highlight #37

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.

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
wants to merge 3 commits into
base: dev
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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 docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,12 @@ const config = {
onBrokenMarkdownLinks: 'warn',
onBrokenAnchors: 'warn',

// Set Mermaid
markdown: {
mermaid: true,
},
themes: ['@docusaurus/theme-mermaid'],

// Performance optimizations with Docusaurus Faster
future: {
experimental_faster: {
Expand Down Expand Up @@ -103,6 +109,17 @@ const config = {
themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
// MermaidJS Config
mermaid: {
theme: {
light: 'neutral',
dark: 'dark',
},
options: {
look: 'handDrawn',
handDrawnSeed: 1,
},
},
// Replace with your project's social card
image: 'img/Logo_RGB.svg',
docs: {
Expand Down Expand Up @@ -205,6 +222,7 @@ const config = {
prism: {
theme: prismThemes.github,
darkTheme: prismThemes.dracula,
additionalLanguages: ['powershell', 'bash'],
},
}),
// Add preconnect for better search performance
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
"@docusaurus/plugin-google-tag-manager": "^3.8.1",
"@docusaurus/plugin-rsdoctor": "^3.8.1",
"@docusaurus/preset-classic": "^3.8.1",
"@docusaurus/theme-mermaid": "^3.8.1",
"@mdx-js/react": "^3.0.0",
"prism-react-renderer": "^2.3.0",
"react": "^18.3.1",
Expand Down