github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-11-21 20:46:30 -05:00
Code Issues Projects Releases Packages Wiki Activity
hugo/hugolib
History
Derk Muenchhausen f0266e2ef3
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`.
2020-06-25 09:51:33 +02:00
..
assets/images Image resource refactor 2019-08-26 15:00:44 +02:00
filesystems hugolib/filesystems: Fix typo in test suite 2020-04-21 23:16:36 +02:00
paths tests: Convert from testify to quicktest 2019-08-12 13:26:32 +02:00
testdata hugolib: Add a site benchmark 2019-08-16 16:24:21 +02:00
testsite hugolib: Add testfile to .gitignore 2019-07-07 13:01:30 +02:00
404_test.go Fix crashes for 404 in IsAncestor etc. 2020-02-22 13:36:04 +01:00
alias.go Fix aliases with relativeURLs 2020-06-14 14:08:41 +02:00
alias_test.go Fix aliases with path in baseURL 2020-06-17 10:52:35 +02:00
breaking_changes_test.go Rename taxonomy kinds from taxonomy to term, taxonomyTerm to taxonomy 2020-06-18 09:09:56 +02:00
cascade_test.go Rename taxonomy kinds from taxonomy to term, taxonomyTerm to taxonomy 2020-06-18 09:09:56 +02:00
case_insensitive_test.go Rework template handling for function and map lookups 2019-12-12 10:04:35 +01:00
collections.go Make Page an interface 2019-03-23 18:51:22 +01:00
collections_test.go tests: Convert from testify to quicktest 2019-08-12 13:26:32 +02:00
config.go modules: Fix "hugo mod get -u" with no arguments 2020-01-30 17:15:35 +01:00
config_test.go tests: Convert from testify to quicktest 2019-08-12 13:26:32 +02:00
configdir_test.go tests: Convert from testify to quicktest 2019-08-12 13:26:32 +02:00
content_map.go Rename taxonomy kinds from taxonomy to term, taxonomyTerm to taxonomy 2020-06-18 09:09:56 +02:00
content_map_page.go Rename taxonomy kinds from taxonomy to term, taxonomyTerm to taxonomy 2020-06-18 09:09:56 +02:00
content_map_test.go Rename taxonomy kinds from taxonomy to term, taxonomyTerm to taxonomy 2020-06-18 09:09:56 +02:00
content_render_hooks_test.go Allow hook template per section/type 2020-06-02 19:02:10 +02:00
datafiles_test.go Add a nested data dir test 2020-06-12 09:14:20 +02:00
disableKinds_test.go Rename taxonomy kinds from taxonomy to term, taxonomyTerm to taxonomy 2020-06-18 09:09:56 +02:00
embedded_shortcodes_test.go Rework template handling for function and map lookups 2019-12-12 10:04:35 +01:00
embedded_templates_norace_test.go Enable the embedded template test when race detector is off 2020-06-25 09:16:28 +02:00
embedded_templates_test.go Enable the embedded template test when race detector is off 2020-06-25 09:16:28 +02:00
fileInfo.go Add Hugo Modules 2019-07-24 09:35:53 +02:00
fileInfo_test.go tests: Convert from testify to quicktest 2019-08-12 13:26:32 +02:00
gitinfo.go Make Page an interface 2019-03-23 18:51:22 +01:00
hugo_modules_test.go Disable a test locally 2020-04-28 12:24:02 +02:00
hugo_sites.go Create robots.txt in the domain root directory 2020-06-20 17:13:26 +02:00
hugo_sites_build.go Create robots.txt in the domain root directory 2020-06-20 17:13:26 +02:00
hugo_sites_build_errors_test.go tpl/tplimpl: Rework template management to get rid of concurrency issues 2020-01-22 09:39:49 +01:00
hugo_sites_build_test.go Create robots.txt in the domain root directory 2020-06-20 17:13:26 +02:00
hugo_sites_multihost_test.go Create robots.txt in the domain root directory 2020-06-20 17:13:26 +02:00
hugo_sites_rebuild_test.go Fix rebuild logic when editing template using a base template 2020-02-28 14:14:55 +01:00
hugo_smoke_test.go Rename taxonomy kinds from taxonomy to term, taxonomyTerm to taxonomy 2020-06-18 09:09:56 +02:00
image_test.go hugolib: Disable a test assertion on ARM 2020-01-22 11:44:29 +01:00
language_content_dir_test.go hugofs: Fix crash in multilingual content fs 2019-10-31 16:11:53 +01:00
menu_test.go tests: Convert from testify to quicktest 2019-08-12 13:26:32 +02:00
minify_publisher_test.go Make Page an interface 2019-03-23 18:51:22 +01:00
multilingual.go Add Hugo Modules 2019-07-24 09:35:53 +02:00
page.go Rename taxonomy kinds from taxonomy to term, taxonomyTerm to taxonomy 2020-06-18 09:09:56 +02:00
page__common.go Add basic "post resource publish support" 2020-04-07 21:59:20 +02:00
page__content.go Fix handling of HTML files without front matter 2020-03-09 15:01:55 +01:00
page__data.go Rename taxonomy kinds from taxonomy to term, taxonomyTerm to taxonomy 2020-06-18 09:09:56 +02:00
page__menus.go Fix typo s/Meny/Menu/ 2019-07-09 17:28:53 +02:00
page__meta.go Rework external asciidoctor integration 2020-06-25 09:51:33 +02:00
page__new.go Add basic "post resource publish support" 2020-04-07 21:59:20 +02:00
page__output.go Fix RenderString vs render hooks 2020-05-24 13:20:57 +02:00
page__paginator.go Rename taxonomy kinds from taxonomy to term, taxonomyTerm to taxonomy 2020-06-18 09:09:56 +02:00
page__paths.go Rename taxonomy kinds from taxonomy to term, taxonomyTerm to taxonomy 2020-06-18 09:09:56 +02:00
page__per_output.go Rework external asciidoctor integration 2020-06-25 09:51:33 +02:00
page__position.go Make Page an interface 2019-03-23 18:51:22 +01:00
page__ref.go Make Page an interface 2019-03-23 18:51:22 +01:00
page__tree.go Rename taxonomy kinds from taxonomy to term, taxonomyTerm to taxonomy 2020-06-18 09:09:56 +02:00
page_kinds.go Rename taxonomy kinds from taxonomy to term, taxonomyTerm to taxonomy 2020-06-18 09:09:56 +02:00
page_permalink_test.go tests: Convert from testify to quicktest 2019-08-12 13:26:32 +02:00
page_test.go Rework external asciidoctor integration 2020-06-25 09:51:33 +02:00
page_unwrap.go Make Page an interface 2019-03-23 18:51:22 +01:00
page_unwrap_test.go Add render template hooks for links and images 2019-12-18 11:44:40 +01:00
pagebundler_test.go Rename taxonomy kinds from taxonomy to term, taxonomyTerm to taxonomy 2020-06-18 09:09:56 +02:00
pagecollections.go Fix GetPage on section/bundle name overlaps 2020-05-24 12:35:45 +02:00
pagecollections_test.go Rename taxonomy kinds from taxonomy to term, taxonomyTerm to taxonomy 2020-06-18 09:09:56 +02:00
pages_capture.go hugolib: Fix error handling in page collector 2020-03-02 11:07:09 +01:00
pages_capture_test.go Introduce a tree map for all content 2020-02-18 09:49:42 +01:00
pages_language_merge_test.go tests: Convert from testify to quicktest 2019-08-12 13:26:32 +02:00
pages_process.go Introduce a tree map for all content 2020-02-18 09:49:42 +01:00
pages_test.go resources/page: Use binary search in Pages.Prev/Next if possible 2019-10-13 12:36:17 +02:00
paginator_test.go Do not render alias paginator pages for non-HTML outputs 2020-01-30 23:45:19 +01:00
permalinker.go Make Page an interface 2019-03-23 18:51:22 +01:00
prune_resources.go cache/filecache: Add a cache prune func 2018-11-14 23:14:51 +01:00
resource_chain_babel_test.go Rename taxonomy kinds from taxonomy to term, taxonomyTerm to taxonomy 2020-06-18 09:09:56 +02:00
resource_chain_test.go Rename taxonomy kinds from taxonomy to term, taxonomyTerm to taxonomy 2020-06-18 09:09:56 +02:00
robotstxt_test.go Spring test cleaning, take 2 2018-03-18 09:54:32 +01:00
rss_test.go tests: Convert from testify to quicktest 2019-08-12 13:26:32 +02:00
shortcode.go Fix crash for closing shortcode with no .Inner set 2020-06-14 20:19:08 +02:00
shortcode_page.go Add render template hooks for links and images 2019-12-18 11:44:40 +01:00
shortcode_test.go Rework external asciidoctor integration 2020-06-25 09:51:33 +02:00
site.go Create robots.txt in the domain root directory 2020-06-20 17:13:26 +02:00
site_benchmark_new_test.go Add Page.GetTerms 2020-02-19 14:52:23 +01:00
site_output.go Rename taxonomy kinds from taxonomy to term, taxonomyTerm to taxonomy 2020-06-18 09:09:56 +02:00
site_output_test.go Rename taxonomy kinds from taxonomy to term, taxonomyTerm to taxonomy 2020-06-18 09:09:56 +02:00
site_render.go Fix aliases with path in baseURL 2020-06-17 10:52:35 +02:00
site_sections.go Simplify page tree logic 2019-08-08 20:13:39 +02:00
site_sections_test.go Introduce a tree map for all content 2020-02-18 09:49:42 +01:00
site_stats_test.go tests: Convert from testify to quicktest 2019-08-12 13:26:32 +02:00
site_test.go Rename taxonomy kinds from taxonomy to term, taxonomyTerm to taxonomy 2020-06-18 09:09:56 +02:00
site_url_test.go tests: Convert from testify to quicktest 2019-08-12 13:26:32 +02:00
siteJSONEncode_test.go hugolib: Add a simple test for jsonify of Site 2019-03-28 09:45:25 +01:00
sitemap_test.go Rework template handling for function and map lookups 2019-12-12 10:04:35 +01:00
taxonomy.go Simplify page tree logic 2019-08-08 20:13:39 +02:00
taxonomy_test.go Rename taxonomy kinds from taxonomy to term, taxonomyTerm to taxonomy 2020-06-18 09:09:56 +02:00
template_test.go Fix Go template script escaping 2020-05-23 22:00:34 +02:00
testhelpers_test.go Create robots.txt in the domain root directory 2020-06-20 17:13:26 +02:00
translations.go Introduce a tree map for all content 2020-02-18 09:49:42 +01:00