mirror of
https://github.com/thegeeklab/hugo-geekblog.git
synced 2024-11-24 22:10:39 +00:00
feat: support mermaid codeblocks (#302)
BREAKING CHANGE: Mermaid can be rendered using code blocks now as an alternative to the shortcode. To support this feature, the minimum supported Hugo version was changed to v0.93.
This commit is contained in:
parent
6f0f82757a
commit
12fc429b87
@ -1,7 +1,7 @@
|
|||||||
# Geekblog
|
# Geekblog
|
||||||
|
|
||||||
[![Build Status](https://img.shields.io/drone/build/thegeeklab/hugo-geekblog?logo=drone&server=https%3A%2F%2Fdrone.thegeeklab.de)](https://drone.thegeeklab.de/thegeeklab/hugo-geekblog)
|
[![Build Status](https://img.shields.io/drone/build/thegeeklab/hugo-geekblog?logo=drone&server=https%3A%2F%2Fdrone.thegeeklab.de)](https://drone.thegeeklab.de/thegeeklab/hugo-geekblog)
|
||||||
[![Hugo Version](https://img.shields.io/badge/hugo-0.65-blue.svg)](https://gohugo.io)
|
[![Hugo Version](https://img.shields.io/badge/hugo-0.93-blue.svg)](https://gohugo.io)
|
||||||
[![GitHub release](https://img.shields.io/github/v/release/thegeeklab/hugo-geekblog)](https://github.com/thegeeklab/hugo-geekblog/releases/latest)
|
[![GitHub release](https://img.shields.io/github/v/release/thegeeklab/hugo-geekblog)](https://github.com/thegeeklab/hugo-geekblog/releases/latest)
|
||||||
[![GitHub contributors](https://img.shields.io/github/contributors/thegeeklab/hugo-geekblog)](https://github.com/thegeeklab/hugo-geekblog/graphs/contributors)
|
[![GitHub contributors](https://img.shields.io/github/contributors/thegeeklab/hugo-geekblog)](https://github.com/thegeeklab/hugo-geekblog/graphs/contributors)
|
||||||
[![License: MIT](https://img.shields.io/github/license/thegeeklab/hugo-geekblog)](https://github.com/thegeeklab/hugo-geekblog/blob/main/LICENSE)
|
[![License: MIT](https://img.shields.io/github/license/thegeeklab/hugo-geekblog)](https://github.com/thegeeklab/hugo-geekblog/blob/main/LICENSE)
|
||||||
|
@ -387,6 +387,37 @@ sequenceDiagram
|
|||||||
|
|
||||||
{{< /columns >}}
|
{{< /columns >}}
|
||||||
|
|
||||||
|
As an alternative to shortcodes, code blocks can be used for markdown as well.
|
||||||
|
|
||||||
|
{{< columns >}}
|
||||||
|
|
||||||
|
<!-- prettier-ignore -->
|
||||||
|
````tpl
|
||||||
|
```mermaid
|
||||||
|
flowchart LR
|
||||||
|
A[Hard] -->|Text| B(Round)
|
||||||
|
B --> C{Decision}
|
||||||
|
C -->|One| D[Result 1]
|
||||||
|
C -->|Two| E[Result 2]
|
||||||
|
```
|
||||||
|
````
|
||||||
|
|
||||||
|
<--->
|
||||||
|
|
||||||
|
<!-- spellchecker-disable -->
|
||||||
|
<!-- prettier-ignore -->
|
||||||
|
```mermaid
|
||||||
|
flowchart LR
|
||||||
|
A[Hard] -->|Text| B(Round)
|
||||||
|
B --> C{Decision}
|
||||||
|
C -->|One| D[Result 1]
|
||||||
|
C -->|Two| E[Result 2]
|
||||||
|
```
|
||||||
|
|
||||||
|
<!-- spellchecker-enable -->
|
||||||
|
|
||||||
|
{{< /columns >}}
|
||||||
|
|
||||||
## KaTeX
|
## KaTeX
|
||||||
|
|
||||||
[KaTeX](https://katex.org/) shortcode let you render math typesetting in markdown document.
|
[KaTeX](https://katex.org/) shortcode let you render math typesetting in markdown document.
|
||||||
|
@ -15,7 +15,7 @@ Geekblog is a simple Hugo theme for personal blogs. It is intentionally designed
|
|||||||
<!--more-->
|
<!--more-->
|
||||||
|
|
||||||
[![Build Status](https://img.shields.io/drone/build/thegeeklab/hugo-geekblog?logo=drone&server=https%3A%2F%2Fdrone.thegeeklab.de)](https://drone.thegeeklab.de/thegeeklab/hugo-geekblog)
|
[![Build Status](https://img.shields.io/drone/build/thegeeklab/hugo-geekblog?logo=drone&server=https%3A%2F%2Fdrone.thegeeklab.de)](https://drone.thegeeklab.de/thegeeklab/hugo-geekblog)
|
||||||
[![Hugo Version](https://img.shields.io/badge/hugo-0.65-blue.svg)](https://gohugo.io)
|
[![Hugo Version](https://img.shields.io/badge/hugo-0.93-blue.svg)](https://gohugo.io)
|
||||||
[![GitHub release](https://img.shields.io/github/v/release/thegeeklab/hugo-geekblog)](https://github.com/thegeeklab/hugo-geekblog/releases/latest)
|
[![GitHub release](https://img.shields.io/github/v/release/thegeeklab/hugo-geekblog)](https://github.com/thegeeklab/hugo-geekblog/releases/latest)
|
||||||
[![GitHub contributors](https://img.shields.io/github/contributors/thegeeklab/hugo-geekblog)](https://github.com/thegeeklab/hugo-geekblog/graphs/contributors)
|
[![GitHub contributors](https://img.shields.io/github/contributors/thegeeklab/hugo-geekblog)](https://github.com/thegeeklab/hugo-geekblog/graphs/contributors)
|
||||||
[![License: MIT](https://img.shields.io/github/license/thegeeklab/hugo-geekblog)](https://github.com/thegeeklab/hugo-geekblog/blob/main/LICENSE)
|
[![License: MIT](https://img.shields.io/github/license/thegeeklab/hugo-geekblog)](https://github.com/thegeeklab/hugo-geekblog/blob/main/LICENSE)
|
||||||
|
11
layouts/_default/_markup/render-codeblock-mermaid.html
Normal file
11
layouts/_default/_markup/render-codeblock-mermaid.html
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
<!-- prettier-ignore-start -->
|
||||||
|
{{ if not (.Page.Scratch.Get "mermaid") }}
|
||||||
|
<!-- Include mermaid only first time -->
|
||||||
|
<script defer src="{{ index (index .Site.Data.assets "mermaid.js") "src" | relURL }}"></script>
|
||||||
|
{{ .Page.Scratch.Set "mermaid" true }}
|
||||||
|
{{ end }}
|
||||||
|
<!-- prettier-ignore-end -->
|
||||||
|
|
||||||
|
<pre class="gblog-mermaid mermaid">
|
||||||
|
{{- .Inner -}}
|
||||||
|
</pre>
|
@ -5,7 +5,7 @@ description = "Hugo theme made for blogs"
|
|||||||
homepage = "https://hugo-geekblog.geekdocs.de/"
|
homepage = "https://hugo-geekblog.geekdocs.de/"
|
||||||
demosite = "https://hugo-geekblog.geekdocs.de/"
|
demosite = "https://hugo-geekblog.geekdocs.de/"
|
||||||
tags = ["blog", "responsive", "simple"]
|
tags = ["blog", "responsive", "simple"]
|
||||||
min_version = "0.65.0"
|
min_version = "0.93.0"
|
||||||
|
|
||||||
[author]
|
[author]
|
||||||
name = "Robert Kaussow"
|
name = "Robert Kaussow"
|
||||||
|
Loading…
Reference in New Issue
Block a user