README.adoc

Antmarky

Antmarky is a static-site generator for Asciidoctor based on Node.js and EJS.

The main idea behind creating Antmarky was to have a generator with zero configuration that can serve your Asciidoctor files in the documentation directory.

Consider Antmarky as a lightweight alternative to Antora.

Currently, Antmarky flattens out the directory structure and displays all the files at the root level under the corresponding directory.

Features

• Zero configuration

• Fully responsive layout

• Fully static (doesn’t require a web server to work)

• No language frameworks included

• Support of major Asciidoctor features:

  • Includes

  • Conditionals

  • Tables

  • Admonitions

• FontAwesome

• Copy code block

Quickstart

Prerequisites

• Docker

Serve content

docker run --rm \
  --name antmarky-ssg \
  -v ${PWD}/docs:/antmarky/docs \
  -p 8000:8000 \
  bandantonio/antmarky

Local server will be launched at http://localhost:8000

Build content

docker run --rm \
  --name antmarky-ssg \
  -v ${PWD}/docs:/antmarky/docs \
  -v ${PWD}/public:/antmarky/public \
  bandantonio/antmarky build

Website static files will be generated in the public directory.