Restructure exampleSite once again, improve sections and flow
This commit is contained in:
@@ -0,0 +1,69 @@
|
||||
# Mermaid
|
||||
|
||||
Render diagrams and charts with [Mermaid](https://mermaid.js.org/). The library is loaded automatically on first use.
|
||||
|
||||
> [!TIP]
|
||||
> Override Mermaid initialization by creating `assets/mermaid.json` in your project.
|
||||
|
||||
## Syntax
|
||||
|
||||
Use fenced code blocks (recommended) or the shortcode
|
||||
|
||||
````tpl
|
||||
```mermaid
|
||||
graph LR
|
||||
A --> B
|
||||
```
|
||||
````
|
||||
|
||||
```tpl
|
||||
{{</* mermaid [class="..."] */>}}
|
||||
graph LR
|
||||
A --> B
|
||||
{{</* /mermaid */>}}
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
{{% columns %}}
|
||||
|
||||
- ```mermaid
|
||||
flowchart TD
|
||||
A[Content Files] --> B[Hugo Build]
|
||||
B --> C[HTML Output]
|
||||
B --> D[Search Index]
|
||||
B --> E[RSS Feed]
|
||||
```
|
||||
|
||||
```mermaid
|
||||
sequenceDiagram
|
||||
Browser->>Hugo: Request page
|
||||
Hugo->>Theme: Apply template
|
||||
Theme->>Browser: Rendered HTML
|
||||
Browser->>Browser: Load shortcodes
|
||||
```
|
||||
|
||||
- ```mermaid
|
||||
pie title Theme Assets
|
||||
"SCSS" : 8
|
||||
"HTML Templates" : 30
|
||||
"JavaScript" : 3
|
||||
"i18n Files" : 35
|
||||
```
|
||||
|
||||
```mermaid
|
||||
gitGraph
|
||||
commit id: "init"
|
||||
commit id: "add theme"
|
||||
branch feature
|
||||
checkout feature
|
||||
commit id: "add docs"
|
||||
commit id: "add config"
|
||||
checkout main
|
||||
merge feature
|
||||
commit id: "deploy"
|
||||
```
|
||||
|
||||
{{% /columns %}}
|
||||
|
||||
Explore more diagram types on the [Mermaid documentation](https://mermaid.js.org/syntax/flowchart.html).
|
||||
Reference in New Issue
Block a user