Skip to content

Enable Mermaid diagrams in docs #77

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
stxrtt wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

Enable Mermaid diagrams in docs #77

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
0c3bbc2
Enable Mermaid diagrams in docs
stxrtt Mar 8, 2026
e3b76e7
docs: update Convex CLI version command to use --version flag
stxrtt Mar 8, 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
2 changes: 1 addition & 1 deletion docs/tutorial/peer-operations/manual-deployment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ cd /opt/convex
wget https://github.com/Convex-Dev/convex/releases/download/v0.8.2/convex.jar

# Verify download
java -jar convex.jar version
java -jar convex.jar --version
```

**Option B: Build from Source**
Expand Down
4 changes: 4 additions & 0 deletions docusaurus.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,14 @@ const config: Config = {
onBrokenLinks: 'warn',

markdown: {
mermaid: true,
hooks: {
onBrokenMarkdownLinks: 'warn'
},
},

// This is for the Mermaid diagrams in the docs.
themes: ['@docusaurus/theme-mermaid'],

// Even if you don't use internationalization, you can use this field to set
// useful metadata like html lang. For example, if your site is Chinese, you
Expand Down
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
"@docusaurus/core": "^3.9.2",
"@docusaurus/plugin-client-redirects": "^3.9.2",
"@docusaurus/preset-classic": "^3.9.2",
"@docusaurus/theme-mermaid": "^3.9.2",
"@mdx-js/react": "^3.1.1",
"@noble/ed25519": "^2.3.0",
"axios": "^1.13.2",
Expand Down
Loading