mirror of
https://github.com/gohugoio/hugo.git
synced 2025-08-16 20:53:59 +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:
@@ -11,13 +11,15 @@
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
|
||||
package transform
|
||||
package transform_test
|
||||
|
||||
import (
|
||||
"html/template"
|
||||
"testing"
|
||||
|
||||
"github.com/gohugoio/hugo/common/loggers"
|
||||
"github.com/gohugoio/hugo/hugolib"
|
||||
"github.com/gohugoio/hugo/tpl/transform"
|
||||
"github.com/spf13/afero"
|
||||
|
||||
qt "github.com/frankban/quicktest"
|
||||
@@ -32,10 +34,11 @@ type tstNoStringer struct{}
|
||||
|
||||
func TestEmojify(t *testing.T) {
|
||||
t.Parallel()
|
||||
c := qt.New(t)
|
||||
b := hugolib.NewIntegrationTestBuilder(
|
||||
hugolib.IntegrationTestConfig{T: t},
|
||||
).Build()
|
||||
|
||||
v := config.New()
|
||||
ns := New(newDeps(v))
|
||||
ns := transform.New(b.H.Deps)
|
||||
|
||||
for _, test := range []struct {
|
||||
s interface{}
|
||||
@@ -49,23 +52,23 @@ func TestEmojify(t *testing.T) {
|
||||
|
||||
result, err := ns.Emojify(test.s)
|
||||
|
||||
if b, ok := test.expect.(bool); ok && !b {
|
||||
c.Assert(err, qt.Not(qt.IsNil))
|
||||
if bb, ok := test.expect.(bool); ok && !bb {
|
||||
b.Assert(err, qt.Not(qt.IsNil))
|
||||
continue
|
||||
}
|
||||
|
||||
c.Assert(err, qt.IsNil)
|
||||
c.Assert(result, qt.Equals, test.expect)
|
||||
b.Assert(err, qt.IsNil)
|
||||
b.Assert(result, qt.Equals, test.expect)
|
||||
}
|
||||
}
|
||||
|
||||
func TestHighlight(t *testing.T) {
|
||||
t.Parallel()
|
||||
c := qt.New(t)
|
||||
b := hugolib.NewIntegrationTestBuilder(
|
||||
hugolib.IntegrationTestConfig{T: t},
|
||||
).Build()
|
||||
|
||||
v := config.New()
|
||||
v.Set("contentDir", "content")
|
||||
ns := New(newDeps(v))
|
||||
ns := transform.New(b.H.Deps)
|
||||
|
||||
for _, test := range []struct {
|
||||
s interface{}
|
||||
@@ -82,23 +85,23 @@ func TestHighlight(t *testing.T) {
|
||||
|
||||
result, err := ns.Highlight(test.s, test.lang, test.opts)
|
||||
|
||||
if b, ok := test.expect.(bool); ok && !b {
|
||||
c.Assert(err, qt.Not(qt.IsNil))
|
||||
if bb, ok := test.expect.(bool); ok && !bb {
|
||||
b.Assert(err, qt.Not(qt.IsNil))
|
||||
continue
|
||||
}
|
||||
|
||||
c.Assert(err, qt.IsNil)
|
||||
c.Assert(string(result), qt.Contains, test.expect.(string))
|
||||
b.Assert(err, qt.IsNil)
|
||||
b.Assert(string(result), qt.Contains, test.expect.(string))
|
||||
}
|
||||
}
|
||||
|
||||
func TestHTMLEscape(t *testing.T) {
|
||||
t.Parallel()
|
||||
c := qt.New(t)
|
||||
b := hugolib.NewIntegrationTestBuilder(
|
||||
hugolib.IntegrationTestConfig{T: t},
|
||||
).Build()
|
||||
|
||||
v := config.New()
|
||||
v.Set("contentDir", "content")
|
||||
ns := New(newDeps(v))
|
||||
ns := transform.New(b.H.Deps)
|
||||
|
||||
for _, test := range []struct {
|
||||
s interface{}
|
||||
@@ -112,23 +115,23 @@ func TestHTMLEscape(t *testing.T) {
|
||||
|
||||
result, err := ns.HTMLEscape(test.s)
|
||||
|
||||
if b, ok := test.expect.(bool); ok && !b {
|
||||
c.Assert(err, qt.Not(qt.IsNil))
|
||||
if bb, ok := test.expect.(bool); ok && !bb {
|
||||
b.Assert(err, qt.Not(qt.IsNil))
|
||||
continue
|
||||
}
|
||||
|
||||
c.Assert(err, qt.IsNil)
|
||||
c.Assert(result, qt.Equals, test.expect)
|
||||
b.Assert(err, qt.IsNil)
|
||||
b.Assert(result, qt.Equals, test.expect)
|
||||
}
|
||||
}
|
||||
|
||||
func TestHTMLUnescape(t *testing.T) {
|
||||
t.Parallel()
|
||||
c := qt.New(t)
|
||||
b := hugolib.NewIntegrationTestBuilder(
|
||||
hugolib.IntegrationTestConfig{T: t},
|
||||
).Build()
|
||||
|
||||
v := config.New()
|
||||
v.Set("contentDir", "content")
|
||||
ns := New(newDeps(v))
|
||||
ns := transform.New(b.H.Deps)
|
||||
|
||||
for _, test := range []struct {
|
||||
s interface{}
|
||||
@@ -142,23 +145,23 @@ func TestHTMLUnescape(t *testing.T) {
|
||||
|
||||
result, err := ns.HTMLUnescape(test.s)
|
||||
|
||||
if b, ok := test.expect.(bool); ok && !b {
|
||||
c.Assert(err, qt.Not(qt.IsNil))
|
||||
if bb, ok := test.expect.(bool); ok && !bb {
|
||||
b.Assert(err, qt.Not(qt.IsNil))
|
||||
continue
|
||||
}
|
||||
|
||||
c.Assert(err, qt.IsNil)
|
||||
c.Assert(result, qt.Equals, test.expect)
|
||||
b.Assert(err, qt.IsNil)
|
||||
b.Assert(result, qt.Equals, test.expect)
|
||||
}
|
||||
}
|
||||
|
||||
func TestMarkdownify(t *testing.T) {
|
||||
t.Parallel()
|
||||
c := qt.New(t)
|
||||
b := hugolib.NewIntegrationTestBuilder(
|
||||
hugolib.IntegrationTestConfig{T: t},
|
||||
).Build()
|
||||
|
||||
v := config.New()
|
||||
v.Set("contentDir", "content")
|
||||
ns := New(newDeps(v))
|
||||
ns := transform.New(b.H.Deps)
|
||||
|
||||
for _, test := range []struct {
|
||||
s interface{}
|
||||
@@ -171,23 +174,24 @@ func TestMarkdownify(t *testing.T) {
|
||||
|
||||
result, err := ns.Markdownify(test.s)
|
||||
|
||||
if b, ok := test.expect.(bool); ok && !b {
|
||||
c.Assert(err, qt.Not(qt.IsNil))
|
||||
if bb, ok := test.expect.(bool); ok && !bb {
|
||||
b.Assert(err, qt.Not(qt.IsNil))
|
||||
continue
|
||||
}
|
||||
|
||||
c.Assert(err, qt.IsNil)
|
||||
c.Assert(result, qt.Equals, test.expect)
|
||||
b.Assert(err, qt.IsNil)
|
||||
b.Assert(result, qt.Equals, test.expect)
|
||||
}
|
||||
}
|
||||
|
||||
// Issue #3040
|
||||
func TestMarkdownifyBlocksOfText(t *testing.T) {
|
||||
t.Parallel()
|
||||
c := qt.New(t)
|
||||
v := config.New()
|
||||
v.Set("contentDir", "content")
|
||||
ns := New(newDeps(v))
|
||||
b := hugolib.NewIntegrationTestBuilder(
|
||||
hugolib.IntegrationTestConfig{T: t},
|
||||
).Build()
|
||||
|
||||
ns := transform.New(b.H.Deps)
|
||||
|
||||
text := `
|
||||
#First
|
||||
@@ -202,17 +206,18 @@ And then some.
|
||||
`
|
||||
|
||||
result, err := ns.Markdownify(text)
|
||||
c.Assert(err, qt.IsNil)
|
||||
c.Assert(result, qt.Equals, template.HTML(
|
||||
b.Assert(err, qt.IsNil)
|
||||
b.Assert(result, qt.Equals, template.HTML(
|
||||
"<p>#First</p>\n<p>This is some <em>bold</em> text.</p>\n<h2 id=\"second\">Second</h2>\n<p>This is some more text.</p>\n<p>And then some.</p>\n"))
|
||||
}
|
||||
|
||||
func TestPlainify(t *testing.T) {
|
||||
t.Parallel()
|
||||
c := qt.New(t)
|
||||
b := hugolib.NewIntegrationTestBuilder(
|
||||
hugolib.IntegrationTestConfig{T: t},
|
||||
).Build()
|
||||
|
||||
v := config.New()
|
||||
ns := New(newDeps(v))
|
||||
ns := transform.New(b.H.Deps)
|
||||
|
||||
for _, test := range []struct {
|
||||
s interface{}
|
||||
@@ -225,13 +230,13 @@ func TestPlainify(t *testing.T) {
|
||||
|
||||
result, err := ns.Plainify(test.s)
|
||||
|
||||
if b, ok := test.expect.(bool); ok && !b {
|
||||
c.Assert(err, qt.Not(qt.IsNil))
|
||||
if bb, ok := test.expect.(bool); ok && !bb {
|
||||
b.Assert(err, qt.Not(qt.IsNil))
|
||||
continue
|
||||
}
|
||||
|
||||
c.Assert(err, qt.IsNil)
|
||||
c.Assert(result, qt.Equals, test.expect)
|
||||
b.Assert(err, qt.IsNil)
|
||||
b.Assert(result, qt.Equals, test.expect)
|
||||
}
|
||||
}
|
||||
|
||||
|
Reference in New Issue
Block a user