mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-07 20:30:36 -05:00
361 lines
8.4 KiB
Go
361 lines
8.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 (
|
|
"bytes"
|
|
"fmt"
|
|
"math/bits"
|
|
"path/filepath"
|
|
"runtime/debug"
|
|
|
|
"github.com/gohugoio/hugo/markup/goldmark/internal/extensions/attributes"
|
|
"github.com/yuin/goldmark/ast"
|
|
|
|
"github.com/gohugoio/hugo/identity"
|
|
|
|
"github.com/pkg/errors"
|
|
|
|
"github.com/spf13/afero"
|
|
|
|
"github.com/gohugoio/hugo/hugofs"
|
|
"github.com/gohugoio/hugo/markup/converter"
|
|
"github.com/gohugoio/hugo/markup/highlight"
|
|
"github.com/gohugoio/hugo/markup/tableofcontents"
|
|
"github.com/yuin/goldmark"
|
|
hl "github.com/yuin/goldmark-highlighting"
|
|
"github.com/yuin/goldmark/extension"
|
|
"github.com/yuin/goldmark/parser"
|
|
"github.com/yuin/goldmark/renderer"
|
|
"github.com/yuin/goldmark/renderer/html"
|
|
"github.com/yuin/goldmark/text"
|
|
"github.com/yuin/goldmark/util"
|
|
)
|
|
|
|
// Provider is the package entry point.
|
|
var Provider converter.ProviderProvider = provide{}
|
|
|
|
type provide struct {
|
|
}
|
|
|
|
func (p provide) New(cfg converter.ProviderConfig) (converter.Provider, error) {
|
|
md := newMarkdown(cfg)
|
|
|
|
return converter.NewProvider("goldmark", func(ctx converter.DocumentContext) (converter.Converter, error) {
|
|
return &goldmarkConverter{
|
|
ctx: ctx,
|
|
cfg: cfg,
|
|
md: md,
|
|
sanitizeAnchorName: func(s string) string {
|
|
return sanitizeAnchorNameString(s, cfg.MarkupConfig.Goldmark.Parser.AutoHeadingIDType)
|
|
},
|
|
}, nil
|
|
}), nil
|
|
}
|
|
|
|
var _ converter.AnchorNameSanitizer = (*goldmarkConverter)(nil)
|
|
|
|
type goldmarkConverter struct {
|
|
md goldmark.Markdown
|
|
ctx converter.DocumentContext
|
|
cfg converter.ProviderConfig
|
|
|
|
sanitizeAnchorName func(s string) string
|
|
}
|
|
|
|
func (c *goldmarkConverter) SanitizeAnchorName(s string) string {
|
|
return c.sanitizeAnchorName(s)
|
|
}
|
|
|
|
func newMarkdown(pcfg converter.ProviderConfig) goldmark.Markdown {
|
|
mcfg := pcfg.MarkupConfig
|
|
cfg := pcfg.MarkupConfig.Goldmark
|
|
var rendererOptions []renderer.Option
|
|
|
|
if cfg.Renderer.HardWraps {
|
|
rendererOptions = append(rendererOptions, html.WithHardWraps())
|
|
}
|
|
|
|
if cfg.Renderer.XHTML {
|
|
rendererOptions = append(rendererOptions, html.WithXHTML())
|
|
}
|
|
|
|
if cfg.Renderer.Unsafe {
|
|
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))
|
|
}
|
|
|
|
if cfg.Extensions.Table {
|
|
extensions = append(extensions, extension.Table)
|
|
}
|
|
|
|
if cfg.Extensions.Strikethrough {
|
|
extensions = append(extensions, extension.Strikethrough)
|
|
}
|
|
|
|
if cfg.Extensions.Linkify {
|
|
extensions = append(extensions, extension.Linkify)
|
|
}
|
|
|
|
if cfg.Extensions.TaskList {
|
|
extensions = append(extensions, extension.TaskList)
|
|
}
|
|
|
|
if cfg.Extensions.Typographer {
|
|
extensions = append(extensions, extension.Typographer)
|
|
}
|
|
|
|
if cfg.Extensions.DefinitionList {
|
|
extensions = append(extensions, extension.DefinitionList)
|
|
}
|
|
|
|
if cfg.Extensions.Footnote {
|
|
extensions = append(extensions, extension.Footnote)
|
|
}
|
|
|
|
if cfg.Parser.AutoHeadingID {
|
|
parserOptions = append(parserOptions, parser.WithAutoHeadingID())
|
|
}
|
|
|
|
if cfg.Parser.Attribute.Title {
|
|
parserOptions = append(parserOptions, parser.WithAttribute())
|
|
}
|
|
|
|
if cfg.Parser.Attribute.Block {
|
|
extensions = append(extensions, attributes.New())
|
|
}
|
|
|
|
md := goldmark.New(
|
|
goldmark.WithExtensions(
|
|
extensions...,
|
|
),
|
|
goldmark.WithParserOptions(
|
|
parserOptions...,
|
|
),
|
|
goldmark.WithRendererOptions(
|
|
rendererOptions...,
|
|
),
|
|
)
|
|
|
|
return md
|
|
}
|
|
|
|
var _ identity.IdentitiesProvider = (*converterResult)(nil)
|
|
|
|
type converterResult struct {
|
|
converter.Result
|
|
toc tableofcontents.Root
|
|
ids identity.Identities
|
|
}
|
|
|
|
func (c converterResult) TableOfContents() tableofcontents.Root {
|
|
return c.toc
|
|
}
|
|
|
|
func (c converterResult) GetIdentities() identity.Identities {
|
|
return c.ids
|
|
}
|
|
|
|
type bufWriter struct {
|
|
*bytes.Buffer
|
|
}
|
|
|
|
const maxInt = 1<<(bits.UintSize-1) - 1
|
|
|
|
func (b *bufWriter) Available() int {
|
|
return maxInt
|
|
}
|
|
|
|
func (b *bufWriter) Buffered() int {
|
|
return b.Len()
|
|
}
|
|
|
|
func (b *bufWriter) Flush() error {
|
|
return nil
|
|
}
|
|
|
|
type renderContext struct {
|
|
*bufWriter
|
|
pos int
|
|
renderContextData
|
|
}
|
|
|
|
type renderContextData interface {
|
|
RenderContext() converter.RenderContext
|
|
DocumentContext() converter.DocumentContext
|
|
AddIdentity(id identity.Provider)
|
|
}
|
|
|
|
type renderContextDataHolder struct {
|
|
rctx converter.RenderContext
|
|
dctx converter.DocumentContext
|
|
ids identity.Manager
|
|
}
|
|
|
|
func (ctx *renderContextDataHolder) RenderContext() converter.RenderContext {
|
|
return ctx.rctx
|
|
}
|
|
|
|
func (ctx *renderContextDataHolder) DocumentContext() converter.DocumentContext {
|
|
return ctx.dctx
|
|
}
|
|
|
|
func (ctx *renderContextDataHolder) AddIdentity(id identity.Provider) {
|
|
ctx.ids.Add(id)
|
|
}
|
|
|
|
var converterIdentity = identity.KeyValueIdentity{Key: "goldmark", Value: "converter"}
|
|
|
|
func (c *goldmarkConverter) Convert(ctx converter.RenderContext) (result converter.Result, err error) {
|
|
defer func() {
|
|
if r := recover(); r != nil {
|
|
dir := afero.GetTempDir(hugofs.Os, "hugo_bugs")
|
|
name := fmt.Sprintf("goldmark_%s.txt", c.ctx.DocumentID)
|
|
filename := filepath.Join(dir, name)
|
|
afero.WriteFile(hugofs.Os, filename, ctx.Src, 07555)
|
|
fmt.Print(string(debug.Stack()))
|
|
err = errors.Errorf("[BUG] goldmark: %s: create an issue on GitHub attaching the file in: %s", r, filename)
|
|
}
|
|
}()
|
|
|
|
buf := &bufWriter{Buffer: &bytes.Buffer{}}
|
|
result = buf
|
|
pctx := c.newParserContext(ctx)
|
|
reader := text.NewReader(ctx.Src)
|
|
|
|
doc := c.md.Parser().Parse(
|
|
reader,
|
|
parser.WithContext(pctx),
|
|
)
|
|
|
|
rcx := &renderContextDataHolder{
|
|
rctx: ctx,
|
|
dctx: c.ctx,
|
|
ids: identity.NewManager(converterIdentity),
|
|
}
|
|
|
|
w := &renderContext{
|
|
bufWriter: buf,
|
|
renderContextData: rcx,
|
|
}
|
|
|
|
if err := c.md.Renderer().Render(w, ctx.Src, doc); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return converterResult{
|
|
Result: buf,
|
|
ids: rcx.ids.GetIdentities(),
|
|
toc: pctx.TableOfContents(),
|
|
}, nil
|
|
}
|
|
|
|
var featureSet = map[identity.Identity]bool{
|
|
converter.FeatureRenderHooks: true,
|
|
}
|
|
|
|
func (c *goldmarkConverter) Supports(feature identity.Identity) bool {
|
|
return featureSet[feature.GetIdentity()]
|
|
}
|
|
|
|
func (c *goldmarkConverter) newParserContext(rctx converter.RenderContext) *parserContext {
|
|
ctx := parser.NewContext(parser.WithIDs(newIDFactory(c.cfg.MarkupConfig.Goldmark.Parser.AutoHeadingIDType)))
|
|
ctx.Set(tocEnableKey, rctx.RenderTOC)
|
|
return &parserContext{
|
|
Context: ctx,
|
|
}
|
|
}
|
|
|
|
type parserContext struct {
|
|
parser.Context
|
|
}
|
|
|
|
func (p *parserContext) TableOfContents() tableofcontents.Root {
|
|
if v := p.Get(tocResultKey); v != nil {
|
|
return v.(tableofcontents.Root)
|
|
}
|
|
return tableofcontents.Root{}
|
|
}
|
|
|
|
func newHighlighting(cfg highlight.Config) goldmark.Extender {
|
|
return hl.NewHighlighting(
|
|
hl.WithStyle(cfg.Style),
|
|
hl.WithGuessLanguage(cfg.GuessSyntax),
|
|
hl.WithCodeBlockOptions(highlight.GetCodeBlockOptions()),
|
|
hl.WithFormatOptions(
|
|
cfg.ToHTMLOptions()...,
|
|
),
|
|
|
|
hl.WithWrapperRenderer(func(w util.BufWriter, ctx hl.CodeBlockContext, entering bool) {
|
|
var language string
|
|
if l, hasLang := ctx.Language(); hasLang {
|
|
language = string(l)
|
|
}
|
|
|
|
if ctx.Highlighted() {
|
|
if entering {
|
|
writeDivStart(w, ctx)
|
|
} else {
|
|
writeDivEnd(w)
|
|
}
|
|
} else {
|
|
if entering {
|
|
highlight.WritePreStart(w, language, "")
|
|
} else {
|
|
highlight.WritePreEnd(w)
|
|
}
|
|
}
|
|
}),
|
|
)
|
|
}
|
|
|
|
func writeDivStart(w util.BufWriter, ctx hl.CodeBlockContext) {
|
|
w.WriteString(`<div class="highlight`)
|
|
|
|
var attributes []ast.Attribute
|
|
if ctx.Attributes() != nil {
|
|
attributes = ctx.Attributes().All()
|
|
}
|
|
|
|
if attributes != nil {
|
|
class, found := ctx.Attributes().GetString("class")
|
|
if found {
|
|
w.WriteString(" ")
|
|
w.Write(util.EscapeHTML(class.([]byte)))
|
|
|
|
}
|
|
_, _ = w.WriteString("\"")
|
|
renderAttributes(w, true, attributes...)
|
|
} else {
|
|
_, _ = w.WriteString("\"")
|
|
}
|
|
|
|
w.WriteString(">")
|
|
}
|
|
|
|
func writeDivEnd(w util.BufWriter) {
|
|
w.WriteString("</div>")
|
|
}
|