Skip to content

feat/add mermaid support #4

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

Merged
stevedylandev merged 3 commits into from
Sep 2, 2025
Merged

feat/add mermaid support #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
608ffaa
feat: add mermaid support
stevedylandev Sep 1, 2025
4a9ec94
chore: updated mermaid to use default theme
stevedylandev Sep 2, 2025
f6c6ad6
chore: updated biome and formatting
stevedylandev Sep 2, 2025
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
3 changes: 3 additions & 0 deletions biome.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@
"recommended": true,
"suspicious": {
"noUnknownAtRules": "off"
},
"security": {
"noDangerouslySetInnerHtml": "info"
}
}
},
Expand Down
24 changes: 0 additions & 24 deletions content/tools/openzeppelin-monitor/v1.x/architecture.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,6 @@ OpenZeppelin Monitor is organized as a data processing pipeline that spans from
The diagram below shows the core processing pipeline of OpenZeppelin Monitor, from blockchain networks and configuration through to notification channels:

```mermaid
%%init: {
'theme': 'base',
'themeVariables': {
'background': '#ffffff',
'mainBkg': '#ffffff',
'primaryBorderColor': '#cccccc'

}}%%
flowchart LR
subgraph "Blockchain Networks"
EVMN["EVM Networks"]
Expand Down Expand Up @@ -81,14 +73,6 @@ The system consists of several core services that are initialized at startup and
### Service Initialization Flow

```mermaid
%%init: {
'theme': 'base',
'themeVariables': {
'background': '#ffffff',
'mainBkg': '#ffffff',
'primaryBorderColor': '#cccccc'

}}%%
graph TD
subgraph Entry Point
MAIN[main.rs]
Expand Down Expand Up @@ -212,14 +196,6 @@ The following table describes the key responsibilities of each service in the Op
The following _runtime flow_ illustrates how data moves through the system, from blockchain networks to notification channels. This sequence represents the core monitoring loop that executes for each configured network.

```mermaid
%%init: {
'theme': 'base',
'themeVariables': {
'background': '#ffffff',
'mainBkg': '#ffffff',
'primaryBorderColor': '#cccccc'

}}%%
sequenceDiagram
participant BWS as BlockWatcherService
participant BS as BlockStorage
Expand Down
10 changes: 1 addition & 9 deletions content/tools/openzeppelin-relayer/v1.x/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,14 +61,6 @@ To get started immediately, see [Quickstart](quickstart.mdx).
## Technical Overview

```mermaid
%%init: {
'theme': 'base',
'themeVariables': {
'background': '#ffffff',
'mainBkg': '#ffffff',
'primaryBorderColor': '#cccccc'

}}%%
flowchart TB
subgraph "Clients"
client[API/SDK]
Expand Down Expand Up @@ -217,7 +209,7 @@ For quick setup with various configurations, check the [examples directory](http
* `evm-gcp-kms-signer`: Using Google Cloud KMS for EVM secure signing
* `evm-turnkey-signer`: Using Turnkey for EVM secure signing
* `solana-turnkey-signer`: Using Turnkey for Solana secure signing
* `redis-storage`: Using Redis for Storage
* `redis-storage`: Using Redis for Storage
* `network-configuration-config-file`: Using Custom network configuration via config file
* `network-configuration-json-file`: Using Custom network configuration via JSON file

Expand Down
16 changes: 9 additions & 7 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,15 @@
"@radix-ui/react-separator": "^1.1.7",
"class-variance-authority": "^0.7.1",
"clsx": "^2.1.1",
"fumadocs-core": "15.6.9",
"fumadocs-mdx": "11.7.3",
"fumadocs-ui": "15.6.9",
"fumadocs-core": "15.7.7",
"fumadocs-mdx": "11.8.2",
"fumadocs-ui": "15.7.7",
"glob": "^11.0.3",
"katex": "^0.16.22",
"lucide-react": "^0.540.0",
"mermaid": "^11.10.1",
"next": "15.4.5",
"next-themes": "^0.4.6",
"react": "^19.1.1",
"react-dom": "^19.1.1",
"rehype-katex": "^7.0.1",
Expand All @@ -33,13 +35,13 @@
},
"devDependencies": {
"@biomejs/biome": "^2.2.2",
"@tailwindcss/postcss": "^4.1.11",
"@tailwindcss/postcss": "^4.1.12",
"@types/mdx": "^2.0.13",
"@types/node": "24.1.0",
"@types/react": "^19.1.9",
"@types/react-dom": "^19.1.7",
"@types/react": "^19.1.12",
"@types/react-dom": "^19.1.9",
"postcss": "^8.5.6",
"tailwindcss": "^4.1.11",
"tailwindcss": "^4.1.12",
"tw-animate-css": "^1.3.7",
"typescript": "^5.9.2"
}
Expand Down
Loading