mirror of
https://github.com/gohugoio/hugo.git
synced 2024-07-04 16:21:57 +00:00
bfb9613a14
This commit adds the fast and CommonMark compliant Goldmark as the new default markdown handler in Hugo. If you want to continue using BlackFriday as the default for md/markdown extensions, you can use this configuration: ```toml [markup] defaultMarkdownHandler="blackfriday" ``` Fixes #5963 Fixes #1778 Fixes #6355
121 lines
3.1 KiB
Go
121 lines
3.1 KiB
Go
// Copyright 2017 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 transform provides template functions for transforming content.
|
|
package transform
|
|
|
|
import (
|
|
"html"
|
|
"html/template"
|
|
|
|
"github.com/gohugoio/hugo/cache/namedmemcache"
|
|
|
|
"github.com/gohugoio/hugo/deps"
|
|
"github.com/gohugoio/hugo/helpers"
|
|
"github.com/spf13/cast"
|
|
)
|
|
|
|
// New returns a new instance of the transform-namespaced template functions.
|
|
func New(deps *deps.Deps) *Namespace {
|
|
cache := namedmemcache.New()
|
|
deps.BuildStartListeners.Add(
|
|
func() {
|
|
cache.Clear()
|
|
})
|
|
|
|
return &Namespace{
|
|
cache: cache,
|
|
deps: deps,
|
|
}
|
|
}
|
|
|
|
// Namespace provides template functions for the "transform" namespace.
|
|
type Namespace struct {
|
|
cache *namedmemcache.Cache
|
|
deps *deps.Deps
|
|
}
|
|
|
|
// Emojify returns a copy of s with all emoji codes replaced with actual emojis.
|
|
//
|
|
// See http://www.emoji-cheat-sheet.com/
|
|
func (ns *Namespace) Emojify(s interface{}) (template.HTML, error) {
|
|
ss, err := cast.ToStringE(s)
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
|
|
return template.HTML(helpers.Emojify([]byte(ss))), nil
|
|
}
|
|
|
|
// Highlight returns a copy of s as an HTML string with syntax
|
|
// highlighting applied.
|
|
func (ns *Namespace) Highlight(s interface{}, lang, opts string) (template.HTML, error) {
|
|
ss, err := cast.ToStringE(s)
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
|
|
highlighted, _ := ns.deps.ContentSpec.Converters.Highlight(ss, lang, opts)
|
|
return template.HTML(highlighted), nil
|
|
}
|
|
|
|
// HTMLEscape returns a copy of s with reserved HTML characters escaped.
|
|
func (ns *Namespace) HTMLEscape(s interface{}) (string, error) {
|
|
ss, err := cast.ToStringE(s)
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
|
|
return html.EscapeString(ss), nil
|
|
}
|
|
|
|
// HTMLUnescape returns a copy of with HTML escape requences converted to plain
|
|
// text.
|
|
func (ns *Namespace) HTMLUnescape(s interface{}) (string, error) {
|
|
ss, err := cast.ToStringE(s)
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
|
|
return html.UnescapeString(ss), nil
|
|
}
|
|
|
|
// Markdownify renders a given input from Markdown to HTML.
|
|
func (ns *Namespace) Markdownify(s interface{}) (template.HTML, error) {
|
|
ss, err := cast.ToStringE(s)
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
|
|
b, err := ns.deps.ContentSpec.RenderMarkdown([]byte(ss))
|
|
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
|
|
// Strip if this is a short inline type of text.
|
|
b = ns.deps.ContentSpec.TrimShortHTML(b)
|
|
|
|
return helpers.BytesToHTML(b), nil
|
|
}
|
|
|
|
// Plainify returns a copy of s with all HTML tags removed.
|
|
func (ns *Namespace) Plainify(s interface{}) (string, error) {
|
|
ss, err := cast.ToStringE(s)
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
|
|
return helpers.StripHTML(ss), nil
|
|
}
|