Skip to content

Latest commit

 

History

History
40 lines (28 loc) · 1.1 KB

README.adoc

File metadata and controls

40 lines (28 loc) · 1.1 KB
Raw

VSHN EPUB3 Generator based on Asciidoctor

This project generates a container image to be used to generate EPUB3 books with a standard VSHN style and fonts.

Build

Run the make command to build the image.

Usage

Run the following command to build an EPUB3 using an Asciidoc file as a basis:

podman run --rm --volume "${PWD}":/documents ghcr.io/vshn/asciidoctor-epub3:1.14.1 file.adoc

Any parameters passed after the command line will be fed directly to Asciidoctor, for example

podman run --rm --volume "${PWD}":/documents ghcr.io/vshn/asciidoctor-epub3:1.14.1 file.adoc --destination-dir=./_archive

Default Attributes

This project sets the following default attributes for the generation of the EPUB3 file:

  • doctype=book

  • epub3-stylesdir=/theme

  • ebook-validate

  • mathematical-format=svg

  • mathematical-inline=true

  • stem=latexmath

  • hide-uri-scheme

  • experimental

  • source-highlighter=rouge

  • pygments-style=bw

  • icons=font

  • icon-set=fi

  • numbered

  • toc

  • toclevels=2

  • sectnumlevels=2

These attributes can be overridden on the command line passing the corresponding --attribute or -a parameter.