diff options
author | Derk Muenchhausen <derk@muenchhausen.de> | 2020-06-25 10:51:33 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-06-25 10:51:33 +0300 |
commit | f0266e2ef3487bc57dd05402002fc816e3b40195 (patch) | |
tree | e6d0e27e4bbfa041a490a2de8e17c60bd7c43a4a /hugolib | |
parent | 77aa385b84dbc1805ff7e34dafeadb181905c689 (diff) |
Rework external asciidoctor integration
This commit solves the relative path problem with asciidoctor tooling. An include will resolve relatively, so you can refer easily to files in the same folder.
Also `asciidoctor-diagram` and PlantUML rendering works now, because the created temporary files will be placed in the correct folder.
This patch covers just the Ruby version of asciidoctor. The old AsciiDoc CLI EOLs in Jan 2020, so this variant is removed from code.
The configuration is completely rewritten and now available in `config.toml` under the key `[markup.asciidocext]`:
```toml
[markup.asciidocext]
extensions = ["asciidoctor-html5s", "asciidoctor-diagram"]
workingFolderCurrent = true
trace = true
[markup.asciidocext.attributes]
my-base-url = "https://example.com/"
my-attribute-name = "my value"
```
- backends, safe-modes, and extensions are now whitelisted to the popular (ruby) extensions and valid values.
- the default for extensions is to not enable any, because they're all external dependencies so the build would break if the user didn't install them beforehand.
- the default backend is html5 because html5s is an external gem dependency.
- the default safe-mode is safe, explanations of the modes: https://asciidoctor.org/man/asciidoctor/
- the config is namespaced under asciidocext_config and the parser looks at asciidocext to allow a future native Go asciidoc.
- `uglyUrls=true` option and `--source` flag are supported
- `--destination` flag is required
Follow the updated documentation under `docs/content/en/content-management/formats.md`.
This patch would be a breaking change, because you need to correct all your absolute include pathes to relative paths, so using relative paths must be configured explicitly by setting `workingFolderCurrent = true`.
Diffstat (limited to 'hugolib')
-rw-r--r-- | hugolib/page__meta.go | 1 | ||||
-rw-r--r-- | hugolib/page__per_output.go | 2 | ||||
-rw-r--r-- | hugolib/page_test.go | 4 | ||||
-rw-r--r-- | hugolib/shortcode_test.go | 4 |
4 files changed, 6 insertions, 5 deletions
diff --git a/hugolib/page__meta.go b/hugolib/page__meta.go index c7226c6f2..5b2d74d00 100644 --- a/hugolib/page__meta.go +++ b/hugolib/page__meta.go @@ -737,6 +737,7 @@ func (p *pageMeta) newContentConverter(ps *pageState, markup string, renderingCo Document: newPageForRenderHook(ps), DocumentID: id, DocumentName: p.Path(), + Filename: p.f.Filename(), ConfigOverrides: renderingConfigOverrides, }, ) diff --git a/hugolib/page__per_output.go b/hugolib/page__per_output.go index 9a2d0b5f9..9e58cc66a 100644 --- a/hugolib/page__per_output.go +++ b/hugolib/page__per_output.go @@ -485,7 +485,7 @@ func splitUserDefinedSummaryAndContent(markup string, c []byte) (summary []byte, startTag := "p" switch markup { - case "asciidoc": + case "asciidocext": startTag = "div" } diff --git a/hugolib/page_test.go b/hugolib/page_test.go index 4c6447d69..2df679a74 100644 --- a/hugolib/page_test.go +++ b/hugolib/page_test.go @@ -20,7 +20,7 @@ import ( "github.com/gohugoio/hugo/markup/rst" - "github.com/gohugoio/hugo/markup/asciidoc" + "github.com/gohugoio/hugo/markup/asciidocext" "github.com/gohugoio/hugo/config" @@ -377,7 +377,7 @@ func testAllMarkdownEnginesForPages(t *testing.T, }{ {"md", func() bool { return true }}, {"mmark", func() bool { return true }}, - {"ad", func() bool { return asciidoc.Supports() }}, + {"ad", func() bool { return asciidocext.Supports() }}, {"rst", func() bool { return rst.Supports() }}, } diff --git a/hugolib/shortcode_test.go b/hugolib/shortcode_test.go index 961450cb8..9e923b093 100644 --- a/hugolib/shortcode_test.go +++ b/hugolib/shortcode_test.go @@ -18,7 +18,7 @@ import ( "path/filepath" "reflect" - "github.com/gohugoio/hugo/markup/asciidoc" + "github.com/gohugoio/hugo/markup/asciidocext" "github.com/gohugoio/hugo/markup/rst" "github.com/spf13/viper" @@ -552,7 +552,7 @@ title: "Foo" temp := tests[:0] for _, test := range tests { - if strings.HasSuffix(test.contentPath, ".ad") && !asciidoc.Supports() { + if strings.HasSuffix(test.contentPath, ".ad") && !asciidocext.Supports() { t.Log("Skip Asciidoc test case as no Asciidoc present.") continue } else if strings.HasSuffix(test.contentPath, ".rst") && !rst.Supports() { |