CODEWITHSUNDEEP
menunavigationasciidocasciidoc
Rodrigo Motta
Rodrigo Motta

Reputation: 65

AsciiDoc navigation panel

How i can create a left navigation panel in AsciiDoc?

like this one here https://docs.asciidoctor.org/asciidoc/latest/

enter image description here

not a list of contents.

enter image description here

Thanks.

Upvotes: 1

Views: 1320

Answers (2)

Der Andsch
Der Andsch

Reputation: 21

The easiest way in my opinion ist to use ASCIIDOC option ":toc:". For your use case you should set :toc:left in the header of your asciidoc File.

Upvotes: 2

eskwayrd
eskwayrd

Reputation: 4521

The navigation pane in your screenshot includes links to many HTML files. asciidoctor doesn't have any built-in facility for generating multiple HTML files from an Asciidoc markup file.

To do that for your own Asciidoc content, you need a tool that processes many Asciidoc files and generates an entire site. Such tools are called static site generators. There are many, and quite a few support Asciidoc markup, including Hugo, Jekyll, and Eleventy.

The Asciidoctor documentation was generated with a tool called Antora, which was created by the author of asciidoctor. Its goal is to specifically support generating technical documentation web sites (and eventually PDF documents) from Asciidoc markup.

Many companies with large sets of technical documentation use Antora. This page lists the companies and sites using Antora, plus public repos with the implementations (where available).

Upvotes: 5

Related Questions