mirror of https://github.com/gohugoio/hugo.git
109 lines
3.9 KiB
Go
109 lines
3.9 KiB
Go
// Copyright 2016 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 helpers
|
|
|
|
import (
|
|
"bytes"
|
|
"html"
|
|
|
|
"github.com/gohugoio/hugo/config"
|
|
"github.com/miekg/mmark"
|
|
"github.com/russross/blackfriday"
|
|
)
|
|
|
|
// LinkResolverFunc describes a custom function to resolve a given link.
|
|
type LinkResolverFunc func(ref string) (string, error)
|
|
|
|
// FileResolverFunc describes a custom function to resolve a given file path.
|
|
type FileResolverFunc func(ref string) (string, error)
|
|
|
|
// HugoHTMLRenderer wraps a blackfriday.Renderer, typically a blackfriday.Html
|
|
// Enabling Hugo to customise the rendering experience
|
|
type HugoHTMLRenderer struct {
|
|
*RenderingContext
|
|
blackfriday.Renderer
|
|
}
|
|
|
|
// BlockCode renders a given text as a block of code.
|
|
// Pygments is used if it is setup to handle code fences.
|
|
func (r *HugoHTMLRenderer) BlockCode(out *bytes.Buffer, text []byte, lang string) {
|
|
if r.Cfg.GetBool("pygmentsCodeFences") && (lang != "" || r.Cfg.GetBool("pygmentsCodeFencesGuessSyntax")) {
|
|
opts := r.Cfg.GetString("pygmentsOptions")
|
|
str := html.UnescapeString(string(text))
|
|
out.WriteString(Highlight(r.RenderingContext.Cfg, str, lang, opts))
|
|
} else {
|
|
r.Renderer.BlockCode(out, text, lang)
|
|
}
|
|
}
|
|
|
|
// ListItem adds task list support to the Blackfriday renderer.
|
|
func (r *HugoHTMLRenderer) ListItem(out *bytes.Buffer, text []byte, flags int) {
|
|
if !r.Config.TaskLists {
|
|
r.Renderer.ListItem(out, text, flags)
|
|
return
|
|
}
|
|
|
|
switch {
|
|
case bytes.HasPrefix(text, []byte("[ ] ")):
|
|
text = append([]byte(`<input type="checkbox" disabled class="task-list-item">`), text[3:]...)
|
|
|
|
case bytes.HasPrefix(text, []byte("[x] ")) || bytes.HasPrefix(text, []byte("[X] ")):
|
|
text = append([]byte(`<input type="checkbox" checked disabled class="task-list-item">`), text[3:]...)
|
|
}
|
|
|
|
r.Renderer.ListItem(out, text, flags)
|
|
}
|
|
|
|
// List adds task list support to the Blackfriday renderer.
|
|
func (r *HugoHTMLRenderer) List(out *bytes.Buffer, text func() bool, flags int) {
|
|
if !r.Config.TaskLists {
|
|
r.Renderer.List(out, text, flags)
|
|
return
|
|
}
|
|
marker := out.Len()
|
|
r.Renderer.List(out, text, flags)
|
|
if out.Len() > marker {
|
|
list := out.Bytes()[marker:]
|
|
if bytes.Contains(list, []byte("task-list-item")) {
|
|
// Find the index of the first >, it might be 3 or 4 depending on whether
|
|
// there is a new line at the start, but this is safer than just hardcoding it.
|
|
closingBracketIndex := bytes.Index(list, []byte(">"))
|
|
// Rewrite the buffer from the marker
|
|
out.Truncate(marker)
|
|
// Safely assuming closingBracketIndex won't be -1 since there is a list
|
|
// May be either dl, ul or ol
|
|
list := append(list[:closingBracketIndex], append([]byte(` class="task-list"`), list[closingBracketIndex:]...)...)
|
|
out.Write(list)
|
|
}
|
|
}
|
|
}
|
|
|
|
// HugoMmarkHTMLRenderer wraps a mmark.Renderer, typically a mmark.html,
|
|
// enabling Hugo to customise the rendering experience.
|
|
type HugoMmarkHTMLRenderer struct {
|
|
mmark.Renderer
|
|
Cfg config.Provider
|
|
}
|
|
|
|
// BlockCode renders a given text as a block of code.
|
|
// Pygments is used if it is setup to handle code fences.
|
|
func (r *HugoMmarkHTMLRenderer) BlockCode(out *bytes.Buffer, text []byte, lang string, caption []byte, subfigure bool, callouts bool) {
|
|
if r.Cfg.GetBool("pygmentsCodeFences") && (lang != "" || r.Cfg.GetBool("pygmentsCodeFencesGuessSyntax")) {
|
|
str := html.UnescapeString(string(text))
|
|
out.WriteString(Highlight(r.Cfg, str, lang, ""))
|
|
} else {
|
|
r.Renderer.BlockCode(out, text, lang, caption, subfigure, callouts)
|
|
}
|
|
}
|