mirror of
https://github.com/gohugoio/hugo.git
synced 2025-08-12 20:13: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:
@@ -30,6 +30,7 @@ import (
|
||||
"github.com/spf13/afero"
|
||||
|
||||
"github.com/gohugoio/hugo/markup/converter"
|
||||
"github.com/gohugoio/hugo/markup/converter/hooks"
|
||||
|
||||
"github.com/gohugoio/hugo/markup"
|
||||
|
||||
@@ -47,8 +48,8 @@ var (
|
||||
// ContentSpec provides functionality to render markdown content.
|
||||
type ContentSpec struct {
|
||||
Converters markup.ConverterProvider
|
||||
MardownConverter converter.Converter // Markdown converter with no document context
|
||||
anchorNameSanitizer converter.AnchorNameSanitizer
|
||||
getRenderer func(t hooks.RendererType, id interface{}) interface{}
|
||||
|
||||
// SummaryLength is the length of the summary that Hugo extracts from a content.
|
||||
summaryLength int
|
||||
@@ -88,7 +89,6 @@ func NewContentSpec(cfg config.Provider, logger loggers.Logger, contentFs afero.
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
spec.MardownConverter = conv
|
||||
if as, ok := conv.(converter.AnchorNameSanitizer); ok {
|
||||
spec.anchorNameSanitizer = as
|
||||
} else {
|
||||
@@ -192,14 +192,6 @@ func ExtractTOC(content []byte) (newcontent []byte, toc []byte) {
|
||||
return
|
||||
}
|
||||
|
||||
func (c *ContentSpec) RenderMarkdown(src []byte) ([]byte, error) {
|
||||
b, err := c.MardownConverter.Convert(converter.RenderContext{Src: src})
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return b.Bytes(), nil
|
||||
}
|
||||
|
||||
func (c *ContentSpec) SanitizeAnchorName(s string) string {
|
||||
return c.anchorNameSanitizer.SanitizeAnchorName(s)
|
||||
}
|
||||
|
Reference in New Issue
Block a user