Skip to content

Commit 90bdc8f

Browse files
author
Drew Yang
committed
fix: 🐛 fix mermaid chart
1 parent 42ddcb5 commit 90bdc8f

File tree

3 files changed

+18
-23
lines changed

3 files changed

+18
-23
lines changed

mkdocs.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@ theme:
7171
name: Switch to light mode
7272
plugins:
7373
- search
74+
- mermaid2
7475
- section-index
7576
# There is no welcome.md anymore
7677
# - redirects:
@@ -96,7 +97,7 @@ markdown_extensions:
9697
custom_fences:
9798
- name: mermaid
9899
class: mermaid
99-
format: !!python/name:pymdownx.superfences.fence_code_format
100+
format: !!python/name:mermaid2.fence_mermaid_custom
100101
- pymdownx.tabbed:
101102
alternate_style: true
102103
- footnotes

pip_requirements.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,5 @@ mkdocs-exclude
44
mdx_truly_sane_lists
55
mkdocs-pymdownx-material-extras
66
pymdown-extensions
7-
mkdocs-section-index
7+
mkdocs-section-index
8+
mkdocs-mermaid2-plugin

src/elements/user-guide.md

Lines changed: 14 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -42,27 +42,20 @@ This diagram describes the general components for a local DataJoint environment.
4242

4343
```mermaid
4444
flowchart LR
45-
py_interp -->|DataJoint| db_server[("Database Server\n(e.g., MySQL)")]
46-
subgraph conda["Conda environment"]
47-
direction TB
48-
py_interp[Python Interpreter]
49-
end
50-
subgraph empty1[" "] %% Empty subgraphs prevent overlapping titles
51-
direction TB
52-
style empty1 fill:none, stroke-dasharray: 0 1
53-
conda
54-
end
55-
subgraph term["Terminal or Jupyter Notebook"]
56-
direction TB
57-
empty1
58-
end
59-
subgraph empty2[" "] %% Empty subgraphs prevent overlapping titles
60-
direction TB
61-
style empty2 fill:none, stroke-dasharray: 0 1
62-
term
63-
end
64-
class py_interp,conda,term,ide,db_server,DataJoint boxes;
65-
classDef boxes fill:#ddd, stroke:#333;
45+
%% Nodes
46+
py_interp["Python Interpreter"]
47+
db_server["Database Server<br>(e.g., MySQL)"]
48+
conda_env["Conda Environment"]
49+
terminal["Terminal or Jupyter Notebook"]
50+
51+
%% Edges
52+
py_interp -->|DataJoint| db_server
53+
terminal --> conda_env
54+
conda_env --> py_interp
55+
56+
%% Styling
57+
classDef boxes fill:#ddd,stroke:#333;
58+
class py_interp,db_server,conda_env,terminal boxes;
6659
```
6760

6861
### Python

0 commit comments

Comments
 (0)