mirror of
https://github.com/gohugoio/hugo.git
synced 2025-08-20 21:31:32 +02:00
Add Markdown diagrams and render hooks for code blocks
You can now create custom hook templates for code blocks, either one for all (`render-codeblock.html`) or for a given code language (e.g. `render-codeblock-go.html`). We also used this new hook to add support for diagrams in Hugo: * Goat (Go ASCII Tool) is built-in and enabled by default; just create a fenced code block with the language `goat` and start draw your Ascii diagrams. * Another popular alternative for diagrams in Markdown, Mermaid (supported by GitHub), can also be implemented with a simple template. See the Hugo documentation for more information. Updates #7765 Closes #9538 Fixes #9553 Fixes #8520 Fixes #6702 Fixes #9558
This commit is contained in:
@@ -36,12 +36,12 @@ func TestAttributeExclusion(t *testing.T) {
|
||||
---
|
||||
title: "p1"
|
||||
---
|
||||
## Heading {class="a" onclick="alert('heading')" linenos="inline"}
|
||||
## Heading {class="a" onclick="alert('heading')"}
|
||||
|
||||
> Blockquote
|
||||
{class="b" ondblclick="alert('blockquote')" LINENOS="inline"}
|
||||
{class="b" ondblclick="alert('blockquote')"}
|
||||
|
||||
~~~bash {id="c" onmouseover="alert('code fence')"}
|
||||
~~~bash {id="c" onmouseover="alert('code fence')" LINENOS=true}
|
||||
foo
|
||||
~~~
|
||||
-- layouts/_default/single.html --
|
||||
@@ -96,6 +96,63 @@ title: "p1"
|
||||
`)
|
||||
}
|
||||
|
||||
func TestAttributesDefaultRenderer(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
files := `
|
||||
-- content/p1.md --
|
||||
---
|
||||
title: "p1"
|
||||
---
|
||||
## Heading Attribute Which Needs Escaping { class="a < b" }
|
||||
-- layouts/_default/single.html --
|
||||
{{ .Content }}
|
||||
`
|
||||
|
||||
b := hugolib.NewIntegrationTestBuilder(
|
||||
hugolib.IntegrationTestConfig{
|
||||
T: t,
|
||||
TxtarString: files,
|
||||
NeedsOsFS: false,
|
||||
},
|
||||
).Build()
|
||||
|
||||
b.AssertFileContent("public/p1/index.html", `
|
||||
class="a < b"
|
||||
`)
|
||||
}
|
||||
|
||||
// Issue 9558.
|
||||
func TestAttributesHookNoEscape(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
files := `
|
||||
-- content/p1.md --
|
||||
---
|
||||
title: "p1"
|
||||
---
|
||||
## Heading Attribute Which Needs Escaping { class="Smith & Wesson" }
|
||||
-- layouts/_default/_markup/render-heading.html --
|
||||
plain: |{{- range $k, $v := .Attributes -}}{{ $k }}: {{ $v }}|{{ end }}|
|
||||
safeHTML: |{{- range $k, $v := .Attributes -}}{{ $k }}: {{ $v | safeHTML }}|{{ end }}|
|
||||
-- layouts/_default/single.html --
|
||||
{{ .Content }}
|
||||
`
|
||||
|
||||
b := hugolib.NewIntegrationTestBuilder(
|
||||
hugolib.IntegrationTestConfig{
|
||||
T: t,
|
||||
TxtarString: files,
|
||||
NeedsOsFS: false,
|
||||
},
|
||||
).Build()
|
||||
|
||||
b.AssertFileContent("public/p1/index.html", `
|
||||
plain: |class: Smith & Wesson|id: heading-attribute-which-needs-escaping|
|
||||
safeHTML: |class: Smith & Wesson|id: heading-attribute-which-needs-escaping|
|
||||
`)
|
||||
}
|
||||
|
||||
// Issue 9504
|
||||
func TestLinkInTitle(t *testing.T) {
|
||||
t.Parallel()
|
||||
@@ -132,6 +189,84 @@ title: "p1"
|
||||
)
|
||||
}
|
||||
|
||||
func TestHighlight(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
files := `
|
||||
-- config.toml --
|
||||
[markup]
|
||||
[markup.highlight]
|
||||
anchorLineNos = false
|
||||
codeFences = true
|
||||
guessSyntax = false
|
||||
hl_Lines = ''
|
||||
lineAnchors = ''
|
||||
lineNoStart = 1
|
||||
lineNos = false
|
||||
lineNumbersInTable = true
|
||||
noClasses = false
|
||||
style = 'monokai'
|
||||
tabWidth = 4
|
||||
-- layouts/_default/single.html --
|
||||
{{ .Content }}
|
||||
-- content/p1.md --
|
||||
---
|
||||
title: "p1"
|
||||
---
|
||||
|
||||
## Code Fences
|
||||
|
||||
§§§bash
|
||||
LINE1
|
||||
§§§
|
||||
|
||||
## Code Fences No Lexer
|
||||
|
||||
§§§moo
|
||||
LINE1
|
||||
§§§
|
||||
|
||||
## Code Fences Simple Attributes
|
||||
|
||||
§§A§bash { .myclass id="myid" }
|
||||
LINE1
|
||||
§§A§
|
||||
|
||||
## Code Fences Line Numbers
|
||||
|
||||
§§§bash {linenos=table,hl_lines=[8,"15-17"],linenostart=199}
|
||||
LINE1
|
||||
LINE2
|
||||
LINE3
|
||||
LINE4
|
||||
LINE5
|
||||
LINE6
|
||||
LINE7
|
||||
LINE8
|
||||
§§§
|
||||
|
||||
|
||||
|
||||
|
||||
`
|
||||
|
||||
// Code fences
|
||||
files = strings.ReplaceAll(files, "§§§", "```")
|
||||
|
||||
b := hugolib.NewIntegrationTestBuilder(
|
||||
hugolib.IntegrationTestConfig{
|
||||
T: t,
|
||||
TxtarString: files,
|
||||
},
|
||||
).Build()
|
||||
|
||||
b.AssertFileContent("public/p1/index.html",
|
||||
"<div class=\"highlight\"><pre tabindex=\"0\" class=\"chroma\"><code class=\"language-bash\" data-lang=\"bash\"><span class=\"line\"><span class=\"cl\">LINE1\n</span></span></code></pre></div>",
|
||||
"Code Fences No Lexer</h2>\n<pre tabindex=\"0\"><code class=\"language-moo\" data-lang=\"moo\">LINE1\n</code></pre>",
|
||||
"lnt",
|
||||
)
|
||||
}
|
||||
|
||||
func BenchmarkRenderHooks(b *testing.B) {
|
||||
files := `
|
||||
-- config.toml --
|
||||
|
Reference in New Issue
Block a user