neelgala/asciidoctor-lists

An asciidoctor extension that adds a list of figures, a list of tables, or a list of anything you want!

asciidoctor-lists

An asciidoctor extension that adds a list of figures, a list of tables, or a list of anything you want!

Pull Requests are always welcome! :)

Important

With version 1.0.6 the syntax was changed from element_list::[element=image] to list-of::image[] to make it more intuitive.

Install

gem install asciidoctor-lists

Sample

Code

...

=== List of figures
list-of::image[]

=== List of tables
list-of::table[]

=== List of code snippets
list-of::listing[]

See samples/list-sample.adoc

Rendered

Parameters

element

Specifies the element to be listed

Sample: samples/list-sample.adoc

enhanced_rendering (experimental)

Allows rendering links in the caption

Sample: samples/enhanced-rendering.adoc

hide_empty_section

Removes the section when no elements are found

Sample: samples/hide-if-empty-list-sample.adoc

Docker

# Build container
docker build -t asciidoctor-lists .
# Run Docker
docker run -it --rm -v $(pwd):/work asciidoctor-lists
# Build sample
asciidoctor-pdf -r asciidoctor-lists samples/list-sample.adoc

Dev setup

Run

asciidoctor -r ./lib/asciidoctor-lists.rb samples/list-sample.adoc

Install Gem

gem build asciidoctor-lists.gemspec
gem install asciidoctor-lists-x.x.x.gem

Docker Image

• Support in official asciidoctor Docker image is waiting for approval (See asciidoctor/docker-asciidoctor#262)