mirror of
https://github.com/gohugoio/hugo.git
synced 2024-07-15 21:28:54 +00:00
08fdca9d93
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
54 lines
1.2 KiB
Go
54 lines
1.2 KiB
Go
package codeblocks
|
|
|
|
import (
|
|
"github.com/yuin/goldmark/ast"
|
|
"github.com/yuin/goldmark/parser"
|
|
"github.com/yuin/goldmark/text"
|
|
)
|
|
|
|
// Kind is the kind of an Hugo code block.
|
|
var KindCodeBlock = ast.NewNodeKind("HugoCodeBlock")
|
|
|
|
// Its raw contents are the plain text of the code block.
|
|
type codeBlock struct {
|
|
ast.BaseBlock
|
|
ordinal int
|
|
b *ast.FencedCodeBlock
|
|
}
|
|
|
|
func (*codeBlock) Kind() ast.NodeKind { return KindCodeBlock }
|
|
|
|
func (*codeBlock) IsRaw() bool { return true }
|
|
|
|
func (b *codeBlock) Dump(src []byte, level int) {
|
|
}
|
|
|
|
type Transformer struct{}
|
|
|
|
// Transform transforms the provided Markdown AST.
|
|
func (*Transformer) Transform(doc *ast.Document, reader text.Reader, pctx parser.Context) {
|
|
var codeBlocks []*ast.FencedCodeBlock
|
|
|
|
ast.Walk(doc, func(node ast.Node, enter bool) (ast.WalkStatus, error) {
|
|
if !enter {
|
|
return ast.WalkContinue, nil
|
|
}
|
|
|
|
cb, ok := node.(*ast.FencedCodeBlock)
|
|
if !ok {
|
|
return ast.WalkContinue, nil
|
|
}
|
|
|
|
codeBlocks = append(codeBlocks, cb)
|
|
return ast.WalkContinue, nil
|
|
})
|
|
|
|
for i, cb := range codeBlocks {
|
|
b := &codeBlock{b: cb, ordinal: i}
|
|
parent := cb.Parent()
|
|
if parent != nil {
|
|
parent.ReplaceChild(parent, cb, b)
|
|
}
|
|
}
|
|
}
|