Skip to content

Commit 0661b61

Browse files
committed
rm mermaid
1 parent c8f4c59 commit 0661b61

File tree

5 files changed

+62
-58
lines changed

5 files changed

+62
-58
lines changed

nbs/_quarto.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ format:
1111
toc: true
1212
toc-depth: 4
1313
keep-md: true
14+
commonmark: default
1415

1516
website:
1617
twitter-card: true

nbs/explanations/docs.ipynb

Lines changed: 1 addition & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -73,53 +73,7 @@
7373
"cell_type": "markdown",
7474
"metadata": {},
7575
"source": [
76-
"```{mermaid}\n",
77-
"flowchart TB\n",
78-
" %%styles\n",
79-
" style JN fill:#FFA500\n",
80-
" style FP fill:#cfe5ed\n",
81-
" style SF fill:#dff1dd,stroke-dasharray: 5 5;\n",
82-
" style QMD fill:#7286bb,color:#fff;\n",
83-
" classDef files fill:#ede8ce ;\n",
84-
" classDef code fill:#5695c7,color:#fff;\n",
85-
" classDef container fill:#f9f9f6;\n",
86-
" \n",
87-
" %% list of nodes\n",
88-
" FP(<strong>Processing Pipeline</strong>\\ntransforms notebook based\\non directives and front-matter)\n",
89-
" E(execnb)\n",
90-
" SD(\"show_doc\")\n",
91-
" SS(<strong>Static Site</strong>\\nHTML, CSS and Javascript)\n",
92-
" CF(\"Intermediate Output is stored in the <code>_procs/</code> directory\\n\\n<i>(This is a full copy of your Quarto project)</i>\")\n",
93-
" class SD,E code;\n",
94-
" \n",
95-
" subgraph SF[\"<strong>Source Files</strong>\"]\n",
96-
" JN([Jupyter\\nNotebook])\n",
97-
" QMD([\"Quarto\\nMarkdown\\n(.qmd)\"])\n",
98-
" end\n",
99-
" \n",
100-
" \n",
101-
" %% connections to things inside Notebook Processor (NBP)\n",
102-
" JN -- json --> FP\n",
103-
" E -. \"cell execution\" .- SD\n",
104-
" \n",
105-
" subgraph NBP [\"&nbsp;<strong>Notebook Processor\\n</strong>&nbsp;\"]\n",
106-
" SD -.- |\"render API docs\"|FP\n",
107-
" end\n",
108-
" \n",
109-
" FP -- modified json with only\\nQuarto directives remaining --> CF\n",
110-
" \n",
111-
" subgraph Quarto [\"&nbsp;<strong>Quarto</strong>\\n&nbsp;<br>\"]\n",
112-
" direction LR\n",
113-
" F[[_quarto.yml]] .-> G[[custom.yml]] & H[[sidebar.yml]]\n",
114-
" class F,G,H files;\n",
115-
" end\n",
116-
" \n",
117-
" QMD --\"rendered\\ndirectly by Quarto\\n(no pre-processing required)\"--> CF\n",
118-
" CF --> Quarto\n",
119-
" Quarto --> SS\n",
120-
" \n",
121-
" class NBP,CF,Quarto container;\n",
122-
"```"
76+
"![](docs.svg)"
12377
]
12478
},
12579
{

nbs/explanations/docs.mermaid

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
flowchart TB
2+
%%styles
3+
style JN fill:#FFA500
4+
style FP fill:#cfe5ed
5+
style SF fill:#dff1dd,stroke-dasharray: 5 5;
6+
style QMD fill:#7286bb,color:#fff;
7+
classDef files fill:#ede8ce ;
8+
classDef code fill:#5695c7,color:#fff;
9+
classDef container fill:#f9f9f6;
10+
11+
%% list of nodes
12+
FP(<strong>Processing Pipeline</strong>
13+
transforms notebook based\non directives and front-matter)
14+
E(execnb)
15+
SD("show_doc")
16+
SS(<strong>Static Site</strong>
17+
HTML, CSS and Javascript)
18+
CF("Intermediate Output is stored in the <code>_procs/</code> directory
19+
20+
<i>(This is a full copy of your Quarto project)</i>")
21+
class SD,E code;
22+
23+
subgraph SF["<strong>Source Files</strong>"]
24+
JN([Jupyter
25+
Notebook])
26+
QMD(["Quarto
27+
Markdown
28+
(.qmd)"])
29+
end
30+
31+
32+
%% connections to things inside Notebook Processor (NBP)
33+
JN -- json --> FP
34+
E -. "cell execution" .- SD
35+
36+
subgraph NBP [" <strong>Notebook Processor
37+
</strong> "]
38+
SD -.- |"render API docs"|FP
39+
end
40+
41+
FP -- modified json with only
42+
Quarto directives remaining --> CF
43+
44+
subgraph Quarto ["<strong>Quarto</strong><br>"]
45+
direction LR
46+
F[[_quarto.yml]] .-> G[[custom.yml]] & H[[sidebar.yml]]
47+
class F,G,H files;
48+
end
49+
50+
QMD --"rendered
51+
directly by Quarto
52+
(no pre-processing required)"--> CF
53+
CF --> Quarto
54+
Quarto --> SS
55+
56+
class NBP,CF,Quarto container;

0 commit comments

Comments
 (0)