mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-29 05:22:08 -05:00
137 lines
4 KiB
Go
137 lines
4 KiB
Go
// Copyright 2019 The Hugo Authors. All rights reserved.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
// Package goldmark converts Markdown to HTML using Goldmark.
|
|
package goldmark
|
|
|
|
import (
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/gohugoio/hugo/markup/converter/hooks"
|
|
"github.com/gohugoio/hugo/markup/markup_config"
|
|
|
|
"github.com/gohugoio/hugo/common/loggers"
|
|
|
|
"github.com/gohugoio/hugo/markup/converter"
|
|
|
|
qt "github.com/frankban/quicktest"
|
|
)
|
|
|
|
var nopGetRenderer = func(t hooks.RendererType, id any) any { return nil }
|
|
|
|
func TestToc(t *testing.T) {
|
|
c := qt.New(t)
|
|
|
|
content := `
|
|
# Header 1
|
|
|
|
## First h2---now with typography!
|
|
|
|
Some text.
|
|
|
|
### H3
|
|
|
|
Some more text.
|
|
|
|
## Second h2
|
|
|
|
And then some.
|
|
|
|
### Second H3
|
|
|
|
#### First H4
|
|
|
|
`
|
|
p, err := Provider.New(
|
|
converter.ProviderConfig{
|
|
MarkupConfig: markup_config.Default,
|
|
Logger: loggers.NewErrorLogger(),
|
|
})
|
|
c.Assert(err, qt.IsNil)
|
|
conv, err := p.New(converter.DocumentContext{})
|
|
c.Assert(err, qt.IsNil)
|
|
b, err := conv.Convert(converter.RenderContext{Src: []byte(content), RenderTOC: true, GetRenderer: nopGetRenderer})
|
|
c.Assert(err, qt.IsNil)
|
|
got := b.(converter.TableOfContentsProvider).TableOfContents().ToHTML(2, 3, false)
|
|
c.Assert(got, qt.Equals, `<nav id="TableOfContents">
|
|
<ul>
|
|
<li><a href="#first-h2---now-with-typography">First h2—now with typography!</a>
|
|
<ul>
|
|
<li><a href="#h3">H3</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#second-h2">Second h2</a>
|
|
<ul>
|
|
<li><a href="#second-h3">Second H3</a></li>
|
|
</ul>
|
|
</li>
|
|
</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, GetRenderer: nopGetRenderer})
|
|
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, GetRenderer: nopGetRenderer})
|
|
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))
|
|
}
|