mirror of
				https://github.com/gohugoio/hugo.git
				synced 2024-05-11 05:54:58 +00:00 
			
		
		
		
	Fix goldmark toc rendering
Previously gordmark-based TOC renderes only `KindText` and `KindString` This commit expands target node with Goldmark's renderer I am not sure of what are expected results as TOC contents in some (rare) cases but Blackfriday's behaviours are fundamentally respected. For example, - image `[image text](link)` is rendered as `<img>` tag - GFM AutoLink `gohugo.io` is rendered as text * Render AutoLink as <a> tag as Blackfriday does Fixes #6736 Fixes #6809
This commit is contained in:
		@@ -81,15 +81,7 @@ func (c *goldmarkConverter) SanitizeAnchorName(s string) string {
 | 
			
		||||
func newMarkdown(pcfg converter.ProviderConfig) goldmark.Markdown {
 | 
			
		||||
	mcfg := pcfg.MarkupConfig
 | 
			
		||||
	cfg := pcfg.MarkupConfig.Goldmark
 | 
			
		||||
 | 
			
		||||
	var (
 | 
			
		||||
		extensions = []goldmark.Extender{
 | 
			
		||||
			newLinks(),
 | 
			
		||||
			newTocExtension(),
 | 
			
		||||
		}
 | 
			
		||||
		rendererOptions []renderer.Option
 | 
			
		||||
		parserOptions   []parser.Option
 | 
			
		||||
	)
 | 
			
		||||
	var rendererOptions []renderer.Option
 | 
			
		||||
 | 
			
		||||
	if cfg.Renderer.HardWraps {
 | 
			
		||||
		rendererOptions = append(rendererOptions, html.WithHardWraps())
 | 
			
		||||
@@ -103,6 +95,14 @@ func newMarkdown(pcfg converter.ProviderConfig) goldmark.Markdown {
 | 
			
		||||
		rendererOptions = append(rendererOptions, html.WithUnsafe())
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	var (
 | 
			
		||||
		extensions = []goldmark.Extender{
 | 
			
		||||
			newLinks(),
 | 
			
		||||
			newTocExtension(rendererOptions),
 | 
			
		||||
		}
 | 
			
		||||
		parserOptions []parser.Option
 | 
			
		||||
	)
 | 
			
		||||
 | 
			
		||||
	if mcfg.Highlight.CodeFences {
 | 
			
		||||
		extensions = append(extensions, newHighlighting(mcfg.Highlight))
 | 
			
		||||
	}
 | 
			
		||||
 
 | 
			
		||||
@@ -21,6 +21,7 @@ import (
 | 
			
		||||
	"github.com/yuin/goldmark"
 | 
			
		||||
	"github.com/yuin/goldmark/ast"
 | 
			
		||||
	"github.com/yuin/goldmark/parser"
 | 
			
		||||
	"github.com/yuin/goldmark/renderer"
 | 
			
		||||
	"github.com/yuin/goldmark/text"
 | 
			
		||||
	"github.com/yuin/goldmark/util"
 | 
			
		||||
)
 | 
			
		||||
@@ -31,6 +32,7 @@ var (
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
type tocTransformer struct {
 | 
			
		||||
	r renderer.Renderer
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (t *tocTransformer) Transform(n *ast.Document, reader text.Reader, pc parser.Context) {
 | 
			
		||||
@@ -79,8 +81,26 @@ func (t *tocTransformer) Transform(n *ast.Document, reader text.Reader, pc parse
 | 
			
		||||
			if found {
 | 
			
		||||
				header.ID = string(id.([]byte))
 | 
			
		||||
			}
 | 
			
		||||
		case ast.KindText, ast.KindString:
 | 
			
		||||
			headingText.Write(n.Text(reader.Source()))
 | 
			
		||||
		case
 | 
			
		||||
			ast.KindCodeSpan,
 | 
			
		||||
			ast.KindLink,
 | 
			
		||||
			ast.KindImage,
 | 
			
		||||
			ast.KindEmphasis:
 | 
			
		||||
			err := t.r.Render(&headingText, reader.Source(), n)
 | 
			
		||||
			if err != nil {
 | 
			
		||||
				return s, err
 | 
			
		||||
			}
 | 
			
		||||
 | 
			
		||||
			return ast.WalkSkipChildren, nil
 | 
			
		||||
		case
 | 
			
		||||
			ast.KindAutoLink,
 | 
			
		||||
			ast.KindRawHTML,
 | 
			
		||||
			ast.KindText,
 | 
			
		||||
			ast.KindString:
 | 
			
		||||
			err := t.r.Render(&headingText, reader.Source(), n)
 | 
			
		||||
			if err != nil {
 | 
			
		||||
				return s, err
 | 
			
		||||
			}
 | 
			
		||||
		}
 | 
			
		||||
 | 
			
		||||
		return s, nil
 | 
			
		||||
@@ -90,12 +110,19 @@ func (t *tocTransformer) Transform(n *ast.Document, reader text.Reader, pc parse
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
type tocExtension struct {
 | 
			
		||||
	options []renderer.Option
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func newTocExtension() goldmark.Extender {
 | 
			
		||||
	return &tocExtension{}
 | 
			
		||||
func newTocExtension(options []renderer.Option) goldmark.Extender {
 | 
			
		||||
	return &tocExtension{
 | 
			
		||||
		options: options,
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (e *tocExtension) Extend(m goldmark.Markdown) {
 | 
			
		||||
	m.Parser().AddOptions(parser.WithASTTransformers(util.Prioritized(&tocTransformer{}, 10)))
 | 
			
		||||
	r := goldmark.DefaultRenderer()
 | 
			
		||||
	r.AddOptions(e.options...)
 | 
			
		||||
	m.Parser().AddOptions(parser.WithASTTransformers(util.Prioritized(&tocTransformer{
 | 
			
		||||
		r: r,
 | 
			
		||||
	}, 10)))
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -15,6 +15,7 @@
 | 
			
		||||
package goldmark
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"strings"
 | 
			
		||||
	"testing"
 | 
			
		||||
 | 
			
		||||
	"github.com/gohugoio/hugo/markup/markup_config"
 | 
			
		||||
@@ -74,3 +75,59 @@ And then some.
 | 
			
		||||
  </ul>
 | 
			
		||||
</nav>`, qt.Commentf(got))
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestEscapeToc(t *testing.T) {
 | 
			
		||||
	c := qt.New(t)
 | 
			
		||||
 | 
			
		||||
	defaultConfig := markup_config.Default
 | 
			
		||||
 | 
			
		||||
	safeConfig := defaultConfig
 | 
			
		||||
	unsafeConfig := defaultConfig
 | 
			
		||||
 | 
			
		||||
	safeConfig.Goldmark.Renderer.Unsafe = false
 | 
			
		||||
	unsafeConfig.Goldmark.Renderer.Unsafe = true
 | 
			
		||||
 | 
			
		||||
	safeP, _ := Provider.New(
 | 
			
		||||
		converter.ProviderConfig{
 | 
			
		||||
			MarkupConfig: safeConfig,
 | 
			
		||||
			Logger:       loggers.NewErrorLogger(),
 | 
			
		||||
		})
 | 
			
		||||
	unsafeP, _ := Provider.New(
 | 
			
		||||
		converter.ProviderConfig{
 | 
			
		||||
			MarkupConfig: unsafeConfig,
 | 
			
		||||
			Logger:       loggers.NewErrorLogger(),
 | 
			
		||||
		})
 | 
			
		||||
	safeConv, _ := safeP.New(converter.DocumentContext{})
 | 
			
		||||
	unsafeConv, _ := unsafeP.New(converter.DocumentContext{})
 | 
			
		||||
 | 
			
		||||
	content := strings.Join([]string{
 | 
			
		||||
		"# A < B & C > D",
 | 
			
		||||
		"# A < B & C > D <div>foo</div>",
 | 
			
		||||
		"# *EMPHASIS*",
 | 
			
		||||
		"# `echo codeblock`",
 | 
			
		||||
	}, "\n")
 | 
			
		||||
	// content := ""
 | 
			
		||||
	b, err := safeConv.Convert(converter.RenderContext{Src: []byte(content), RenderTOC: true})
 | 
			
		||||
	c.Assert(err, qt.IsNil)
 | 
			
		||||
	got := b.(converter.TableOfContentsProvider).TableOfContents().ToHTML(1, 2, false)
 | 
			
		||||
	c.Assert(got, qt.Equals, `<nav id="TableOfContents">
 | 
			
		||||
  <ul>
 | 
			
		||||
    <li><a href="#a--b--c--d">A < B & C > D</a></li>
 | 
			
		||||
    <li><a href="#a--b--c--d-divfoodiv">A < B & C > D <!-- raw HTML omitted -->foo<!-- raw HTML omitted --></a></li>
 | 
			
		||||
    <li><a href="#emphasis"><em>EMPHASIS</em></a></li>
 | 
			
		||||
    <li><a href="#echo-codeblock"><code>echo codeblock</code></a></li>
 | 
			
		||||
  </ul>
 | 
			
		||||
</nav>`, qt.Commentf(got))
 | 
			
		||||
 | 
			
		||||
	b, err = unsafeConv.Convert(converter.RenderContext{Src: []byte(content), RenderTOC: true})
 | 
			
		||||
	c.Assert(err, qt.IsNil)
 | 
			
		||||
	got = b.(converter.TableOfContentsProvider).TableOfContents().ToHTML(1, 2, false)
 | 
			
		||||
	c.Assert(got, qt.Equals, `<nav id="TableOfContents">
 | 
			
		||||
  <ul>
 | 
			
		||||
    <li><a href="#a--b--c--d">A < B & C > D</a></li>
 | 
			
		||||
    <li><a href="#a--b--c--d-divfoodiv">A < B & C > D <div>foo</div></a></li>
 | 
			
		||||
    <li><a href="#emphasis"><em>EMPHASIS</em></a></li>
 | 
			
		||||
    <li><a href="#echo-codeblock"><code>echo codeblock</code></a></li>
 | 
			
		||||
  </ul>
 | 
			
		||||
</nav>`, qt.Commentf(got))
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user