mirror of
https://github.com/gohugoio/hugo.git
synced 2024-05-20 16:22:49 +00:00
c9e679075f
Current options are:
markup:
pandoc:
filters:
- list
- of
- filters
extensions:
- list
- of
- extensions
extraArgs:
- --extra-arguments
- --one-per-line
Generalize some Pandoc options.
Support configuring a bibliography in markup config
Anonymous Update
[pandoc] Allow page parameters to override site parameters.
This allows specifying things like this in the page frontmatter:
---
title: Something
bibliography:
source: mybibliography.bib
pandoc:
filter:
- make-diagrams.lua
...
These options are local to the page. Specifying the same under `markup`
in the site configuration applies those settings to all pages.
Paths (filters, bibliography, citation style) are resolved relative to
the page, site, and the `static` folder.
[pandoc] Support metadata
Support specifying Pandoc metadata in the site configuration and page
configuration using the following syntax:
Site (in `config.yaml`):
```yaml
markup:
pandoc:
metadata:
link-citations: true
```
Or in frontmatter:
```yaml
---
pandoc:
metadata:
link-citations: true
...
```
[pandoc] Simplify path management.
No need for any fancy path lookup gymnastics. `pandoc`'s
`--resource-path` option does the legwork of locating resources on
multiple directories.
[pandoc] Don't use x != "" to denote failure.
116 lines
3 KiB
Go
116 lines
3 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_config
|
|
|
|
import (
|
|
"github.com/gohugoio/hugo/common/maps"
|
|
"github.com/gohugoio/hugo/config"
|
|
"github.com/gohugoio/hugo/markup/asciidocext/asciidocext_config"
|
|
"github.com/gohugoio/hugo/markup/bibliography"
|
|
"github.com/gohugoio/hugo/markup/goldmark/goldmark_config"
|
|
"github.com/gohugoio/hugo/markup/highlight"
|
|
"github.com/gohugoio/hugo/markup/pandoc/pandoc_config"
|
|
"github.com/gohugoio/hugo/markup/tableofcontents"
|
|
"github.com/mitchellh/mapstructure"
|
|
)
|
|
|
|
type Config struct {
|
|
// Default markdown handler for md/markdown extensions.
|
|
// Default is "goldmark".
|
|
DefaultMarkdownHandler string
|
|
|
|
// The configuration used by code highlighters.
|
|
Highlight highlight.Config
|
|
|
|
// Table of contents configuration
|
|
TableOfContents tableofcontents.Config
|
|
Bibliography bibliography.Config
|
|
|
|
// Configuration for the Goldmark markdown engine.
|
|
Goldmark goldmark_config.Config
|
|
|
|
// Configuration for the Asciidoc external markdown engine.
|
|
AsciidocExt asciidocext_config.Config
|
|
|
|
// Configuration for Pandoc external markdown engine.
|
|
Pandoc pandoc_config.Config
|
|
}
|
|
|
|
func Decode(cfg config.Provider) (conf Config, err error) {
|
|
conf = Default
|
|
|
|
m := cfg.GetStringMap("markup")
|
|
if m == nil {
|
|
return
|
|
}
|
|
m = maps.CleanConfigStringMap(m)
|
|
|
|
normalizeConfig(m)
|
|
|
|
err = mapstructure.WeakDecode(m, &conf)
|
|
if err != nil {
|
|
return
|
|
}
|
|
|
|
if err = highlight.ApplyLegacyConfig(cfg, &conf.Highlight); err != nil {
|
|
return
|
|
}
|
|
|
|
return
|
|
}
|
|
|
|
func normalizeConfig(m map[string]any) {
|
|
v, err := maps.GetNestedParam("goldmark.parser", ".", m)
|
|
if err == nil {
|
|
vm := maps.ToStringMap(v)
|
|
// Changed from a bool in 0.81.0
|
|
if vv, found := vm["attribute"]; found {
|
|
if vvb, ok := vv.(bool); ok {
|
|
vm["attribute"] = goldmark_config.ParserAttribute{
|
|
Title: vvb,
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// Changed from a bool in 0.112.0.
|
|
v, err = maps.GetNestedParam("goldmark.extensions", ".", m)
|
|
if err == nil {
|
|
vm := maps.ToStringMap(v)
|
|
const typographerKey = "typographer"
|
|
if vv, found := vm[typographerKey]; found {
|
|
if vvb, ok := vv.(bool); ok {
|
|
if !vvb {
|
|
vm[typographerKey] = goldmark_config.Typographer{
|
|
Disable: true,
|
|
}
|
|
} else {
|
|
delete(vm, typographerKey)
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
var Default = Config{
|
|
DefaultMarkdownHandler: "goldmark",
|
|
|
|
TableOfContents: tableofcontents.DefaultConfig,
|
|
Highlight: highlight.DefaultConfig,
|
|
Bibliography: bibliography.Default,
|
|
|
|
Goldmark: goldmark_config.Default,
|
|
AsciidocExt: asciidocext_config.Default,
|
|
}
|