mirror/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2025-08-18 21:11:19 +02:00
Code Issues Packages Projects Releases Wiki Activity

markup/asciidocext: Fix AsciiDoc TOC with code

Browse Source 
Fixes #7649
This commit is contained in:
Helder Pereira
2020-09-09 22:41:53 +01:00
committed by Bjørn Erik Pedersen
parent 746ba803af
commit 6a848cbc3a
5 changed files with 99 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/content/en/content-management/formats.md
View File

@@ -49,7 +49,7 @@ tool on your machine to be able to use these formats.
Hugo passes reasonable default arguments to these external helpers by default:
- `asciidoctor`: `--no-header-footer --trace -`
- `asciidoctor`: `--no-header-footer -`
- `rst2html`: `--leave-comments --initial-header-level=2`
- `pandoc`: `--mathjax`
@@ -81,7 +81,7 @@ noheaderorfooter | true | Output an embeddable document, which excludes the head
safemode | `unsafe` | Safe mode level `unsafe`, `safe`, `server` or `secure`. Don't change this unless you know what you are doing.
sectionnumbers | `false` | Auto-number section titles.
verbose | `false` | Verbosely print processing information and configuration file checks to stderr.
trace | `true` | Include backtrace information on errors.
trace | `false` | Include backtrace information on errors.
failurelevel | `fatal` | The minimum logging level that triggers a non-zero exit code (failure).
workingfoldercurrent | `false` | Set the working folder to the rendered `adoc` file, so [include](https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/#include-files) will work with relative paths. This setting uses the `asciidoctor` cli parameter `--base-dir` and attribute `outdir=`. For rendering [asciidoctor-diagram](https://asciidoctor.org/docs/asciidoctor-diagram/) `workingfoldercurrent` must be set to `true`.

8
docs/content/en/content-management/toc.md
View File

@@ -92,11 +92,11 @@ The following is a [partial template][partials] that adds slightly more logic fo
With the preceding example, even pages with > 400 words *and* `toc` not set to `false` will not render a table of contents if there are no headings in the page for the `{{.TableOfContents}}` variable to pull from.
{{% /note %}}
## Usage with asciidoc
## Usage with AsciiDoc
Hugo supports table of contents with Asciidoc content format.
Hugo supports table of contents with AsciiDoc content format.
In the header of your content file, specify the Asciidoc TOC directives, by using the macro style:
In the header of your content file, specify the AsciiDoc TOC directives, by using the macro or auto style:
```asciidoc
// <!-- Your front matter up here -->
@@ -117,7 +117,7 @@ He lay on his armour-like back, and if he lifted his head a little he could see
A collection of textile samples lay spread out on the table - Samsa was a travelling salesman - and above it there hung a picture that he had recently cut out of an illustrated magazine and housed in a nice, gilded frame. It showed a lady fitted out with a fur hat and fur boa who sat upright, raising a heavy fur muff that covered the whole of her lower arm towards the viewer. Gregor then turned to look out the window at the dull weather. Drops
```
Hugo will take this Asciddoc and create a table of contents store it in the page variable `.TableOfContents`, in the same as described for Markdown.
Hugo will take this AsciiDoc and create a table of contents store it in the page variable `.TableOfContents`, in the same as described for Markdown.
[conditionals]: /templates/introduction/#conditionals
[front matter]: /content-management/front-matter/