Loading...

May 23, 2014

Awesome Asciidoctor: Turn Section Titles Into Links

When we use Asciidoctor to write and generate our documentation we can use the document attributes sectanchors or sectlinks to turn section titles into link references. This can be useful if we want for example to bookmark a section.

The sectanchors attribute will show a section icon in front of the section title when we hover over the title. The icon itself is the link to the section.

Section title in generated HTML output.

Hover over section title and icon is shown.

Section icon is link reference.

With the sectlinks attribute the section title itself is the link. So we don't get an icon if we hover of the title, but the title text itself is now the link.

The section title is now a link.