Skip to content

Commit

Permalink
rm mermaid
Browse files Browse the repository at this point in the history
  • Loading branch information
jph00 committed Oct 20, 2024
1 parent c8f4c59 commit 0661b61
Show file tree
Hide file tree
Showing 5 changed files with 62 additions and 58 deletions.
1 change: 1 addition & 0 deletions nbs/_quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ format:
toc: true
toc-depth: 4
keep-md: true
commonmark: default

website:
twitter-card: true
Expand Down
48 changes: 1 addition & 47 deletions nbs/explanations/docs.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -73,53 +73,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"```{mermaid}\n",
"flowchart TB\n",
" %%styles\n",
" style JN fill:#FFA500\n",
" style FP fill:#cfe5ed\n",
" style SF fill:#dff1dd,stroke-dasharray: 5 5;\n",
" style QMD fill:#7286bb,color:#fff;\n",
" classDef files fill:#ede8ce ;\n",
" classDef code fill:#5695c7,color:#fff;\n",
" classDef container fill:#f9f9f6;\n",
" \n",
" %% list of nodes\n",
" FP(<strong>Processing Pipeline</strong>\\ntransforms notebook based\\non directives and front-matter)\n",
" E(execnb)\n",
" SD(\"show_doc\")\n",
" SS(<strong>Static Site</strong>\\nHTML, CSS and Javascript)\n",
" 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",
" class SD,E code;\n",
" \n",
" subgraph SF[\"<strong>Source Files</strong>\"]\n",
" JN([Jupyter\\nNotebook])\n",
" QMD([\"Quarto\\nMarkdown\\n(.qmd)\"])\n",
" end\n",
" \n",
" \n",
" %% connections to things inside Notebook Processor (NBP)\n",
" JN -- json --> FP\n",
" E -. \"cell execution\" .- SD\n",
" \n",
" subgraph NBP [\"&nbsp;<strong>Notebook Processor\\n</strong>&nbsp;\"]\n",
" SD -.- |\"render API docs\"|FP\n",
" end\n",
" \n",
" FP -- modified json with only\\nQuarto directives remaining --> CF\n",
" \n",
" subgraph Quarto [\"&nbsp;<strong>Quarto</strong>\\n&nbsp;<br>\"]\n",
" direction LR\n",
" F[[_quarto.yml]] .-> G[[custom.yml]] & H[[sidebar.yml]]\n",
" class F,G,H files;\n",
" end\n",
" \n",
" QMD --\"rendered\\ndirectly by Quarto\\n(no pre-processing required)\"--> CF\n",
" CF --> Quarto\n",
" Quarto --> SS\n",
" \n",
" class NBP,CF,Quarto container;\n",
"```"
"![](docs.svg)"
]
},
{
Expand Down
56 changes: 56 additions & 0 deletions nbs/explanations/docs.mermaid
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
flowchart TB
%%styles
style JN fill:#FFA500
style FP fill:#cfe5ed
style SF fill:#dff1dd,stroke-dasharray: 5 5;
style QMD fill:#7286bb,color:#fff;
classDef files fill:#ede8ce ;
classDef code fill:#5695c7,color:#fff;
classDef container fill:#f9f9f6;

%% list of nodes
FP(<strong>Processing Pipeline</strong>
transforms notebook based\non directives and front-matter)
E(execnb)
SD("show_doc")
SS(<strong>Static Site</strong>
HTML, CSS and Javascript)
CF("Intermediate Output is stored in the <code>_procs/</code> directory

<i>(This is a full copy of your Quarto project)</i>")
class SD,E code;

subgraph SF["<strong>Source Files</strong>"]
JN([Jupyter
Notebook])
QMD(["Quarto
Markdown
(.qmd)"])
end


%% connections to things inside Notebook Processor (NBP)
JN -- json --> FP
E -. "cell execution" .- SD

subgraph NBP [" <strong>Notebook Processor
</strong> "]
SD -.- |"render API docs"|FP
end

FP -- modified json with only
Quarto directives remaining --> CF

subgraph Quarto ["<strong>Quarto</strong><br>"]
direction LR
F[[_quarto.yml]] .-> G[[custom.yml]] & H[[sidebar.yml]]
class F,G,H files;
end

QMD --"rendered
directly by Quarto
(no pre-processing required)"--> CF
CF --> Quarto
Quarto --> SS

class NBP,CF,Quarto container;
Loading

0 comments on commit 0661b61

Please sign in to comment.