mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-07 20:30:36 -05: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
131 lines
3.4 KiB
Go
131 lines
3.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 markup
|
|
|
|
import (
|
|
"strings"
|
|
|
|
"github.com/gohugoio/hugo/markup/highlight"
|
|
|
|
"github.com/gohugoio/hugo/markup/markup_config"
|
|
|
|
"github.com/gohugoio/hugo/markup/goldmark"
|
|
|
|
"github.com/gohugoio/hugo/markup/org"
|
|
|
|
"github.com/gohugoio/hugo/markup/asciidoc"
|
|
"github.com/gohugoio/hugo/markup/blackfriday"
|
|
"github.com/gohugoio/hugo/markup/converter"
|
|
"github.com/gohugoio/hugo/markup/mmark"
|
|
"github.com/gohugoio/hugo/markup/pandoc"
|
|
"github.com/gohugoio/hugo/markup/rst"
|
|
)
|
|
|
|
func NewConverterProvider(cfg converter.ProviderConfig) (ConverterProvider, error) {
|
|
converters := make(map[string]converter.Provider)
|
|
|
|
markupConfig, err := markup_config.Decode(cfg.Cfg)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
if cfg.Highlight == nil {
|
|
h := highlight.New(markupConfig.Highlight)
|
|
cfg.Highlight = func(code, lang, optsStr string) (string, error) {
|
|
return h.Highlight(code, lang, optsStr)
|
|
}
|
|
}
|
|
|
|
cfg.MarkupConfig = markupConfig
|
|
|
|
add := func(p converter.ProviderProvider, aliases ...string) error {
|
|
c, err := p.New(cfg)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
name := c.Name()
|
|
|
|
aliases = append(aliases, name)
|
|
|
|
if strings.EqualFold(name, cfg.MarkupConfig.DefaultMarkdownHandler) {
|
|
aliases = append(aliases, "markdown")
|
|
}
|
|
|
|
addConverter(converters, c, aliases...)
|
|
return nil
|
|
}
|
|
|
|
if err := add(goldmark.Provider); err != nil {
|
|
return nil, err
|
|
}
|
|
if err := add(blackfriday.Provider); err != nil {
|
|
return nil, err
|
|
}
|
|
if err := add(mmark.Provider); err != nil {
|
|
return nil, err
|
|
}
|
|
if err := add(asciidoc.Provider, "ad", "adoc"); err != nil {
|
|
return nil, err
|
|
}
|
|
if err := add(rst.Provider); err != nil {
|
|
return nil, err
|
|
}
|
|
if err := add(pandoc.Provider, "pdc"); err != nil {
|
|
return nil, err
|
|
}
|
|
if err := add(org.Provider); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return &converterRegistry{
|
|
config: cfg,
|
|
converters: converters,
|
|
}, nil
|
|
}
|
|
|
|
type ConverterProvider interface {
|
|
Get(name string) converter.Provider
|
|
//Default() converter.Provider
|
|
GetMarkupConfig() markup_config.Config
|
|
Highlight(code, lang, optsStr string) (string, error)
|
|
}
|
|
|
|
type converterRegistry struct {
|
|
// Maps name (md, markdown, blackfriday etc.) to a converter provider.
|
|
// Note that this is also used for aliasing, so the same converter
|
|
// may be registered multiple times.
|
|
// All names are lower case.
|
|
converters map[string]converter.Provider
|
|
|
|
config converter.ProviderConfig
|
|
}
|
|
|
|
func (r *converterRegistry) Get(name string) converter.Provider {
|
|
return r.converters[strings.ToLower(name)]
|
|
}
|
|
|
|
func (r *converterRegistry) Highlight(code, lang, optsStr string) (string, error) {
|
|
return r.config.Highlight(code, lang, optsStr)
|
|
}
|
|
|
|
func (r *converterRegistry) GetMarkupConfig() markup_config.Config {
|
|
return r.config.MarkupConfig
|
|
}
|
|
|
|
func addConverter(m map[string]converter.Provider, c converter.Provider, aliases ...string) {
|
|
for _, alias := range aliases {
|
|
m[alias] = c
|
|
}
|
|
}
|