Use cases for typical situations you may encounter.
Add a TOC to a document written without one, so that it’s easier to navigate and use.
Problem: A document is not written with a TOC
It’s long. It’s hard to navigate.
Solution: Use Asciidoctor Browser Extension to add a TOC
toc setting depending on your need below:
To remove a TOC that’s already there use
Reduce the TOC heading levels for a simplified view of the document.
Problem: The number of section levels and headings are many
A simple view of the TOC is needed to understand the document.
Solution: Use the viewer to reduce the TOC heading levels
toclevels controls the section levels that are included in the TOC, from 1 to 7.
toclevels setting depending on your need below:
To see more detail in the TOC, increase the
Create and write an AsciiDoc quickly using the Asciidoctor Browser Extension to apply your most commonly used settings.
Objective: Just write, leaving other settings until later if at all
Use the features of Asciidoctor Browser Extension to save time.
Solution: Put commonly used attributes into the Option: Custom Attributes String
For all documents viewed, set this custom attributes option string:
toc=left icons=font experimental source-highlighter=highlight.js
The above Custom attributes options string set the equivalent AsciiDoc attributes below:
= <title> :toc: left (1) :icons: font (2) :experimental: (3) :source-highlighter: highlight.js (4)
|1||A left hand TOC|
|2||Use Font Awesome for icons and admonition icons|
|3||Enable GUI macros
|4||Syntax highlighting with
Congratulations, you can now have a collection of AsciiDoc notes with minimal effort, and view them with the Asciidoctor Browser Extension.