Armquill
Log In Sign Up

Output Formats

Armquill supports multiple output formats depending on your document type. Select the output format from the dropdown next to the compile button in the editor.

Table of Contents

PDF

PDF is the default output format and is available for all document types (LaTeX, Typst, AsciiDoc, and Markdown). It produces publication-ready documents suitable for printing, sharing, and archiving.

HTML

HTML output is available for AsciiDoc and Markdown documents. It generates standalone HTML files that can be opened in any web browser.

EPUB

EPUB is the standard ebook format supported by all major e-readers including Apple Books, Kobo, Google Play Books, and most reading apps. EPUB files are reflowable, meaning the text adapts to the reader's screen size and font preferences.

You can create EPUB files using AsciiDoc or Markdown projects in Armquill. To get started quickly, browse the EPUB templates in the public template gallery — they come pre-configured with cover images, styling, and metadata so you can focus on writing.

Tip: When working on an EPUB, using a detached viewer provides a better preview of the ebook. Click the detach button in the preview panel to open it in a separate window.

Create EPUB with AsciiDoc

AsciiDoc projects use asciidoctor-epub3 to generate EPUB files. To compile an EPUB, set the output format to EPUB in the dropdown and click Compile.

Default styling

Asciidoctor-epub3 provides built-in styles that produce a clean, readable ebook out of the box. No additional configuration is needed for basic use.

Metadata

Set ebook metadata using AsciiDoc attributes in the document header. These attributes control how your book appears in e-reader libraries: 

= Book Title
Author Name
:description: A brief description of the book
:keywords: fiction, adventure, fantasy
:publisher: Publisher Name
:series-name: Series Title
:series-volume: 1

Cover images

Add a cover image to your EPUB using the :front-cover-image: attribute: 

:front-cover-image: image:figures/cover.jpg[Front Cover,1600,2400]

The recommended cover image size is 1600 x 2400 pixels (2:3 aspect ratio). Upload the image to your project's file panel and reference it by path.

Figures

Include images in your EPUB using the AsciiDoc image:: block macro: 

// Full-page figure
image::figures/map.png[Map of the World]

// In-text figure with sizing
image::figures/diagram.png[Diagram,width=80%]

Upload your image files to the project and reference them using relative paths from the document root.

Custom styling

You can customize the EPUB's appearance using SCSS stylesheets. Set the :epub3-stylesdir: attribute to point to your styles directory: 

:epub3-stylesdir: styles

When using custom styles, your styles directory must include all of the default SCSS files that asciidoctor-epub3 expects. The required files are:

  • epub3.scss — main entry point
  • epub3-css3-only.scss — CSS3-only styles for capable readers
  • epub3-fonts.scss — font declarations
  • _reset.scss — CSS reset
  • _defaults.scss — default element styles
  • _colors.scss — color definitions

You can add additional SCSS partials (e.g. _novel.scss) and import them from epub3.scss using @import.

Considerations

  • Make sure there are no blank lines in the AsciiDoc document header (between the title and the last attribute). Blank lines end the header and can cause attributes to be ignored.
  • When using include:: directives in your main file, separate each include with an empty line. Without the empty line between them, content may not render correctly.
  • EPUB readers may override your CSS with their own font and layout preferences. Test your EPUB across multiple readers to check how it renders.
  • For the best results, test on Apple Books, Kobo, and a mobile reading app to cover a range of rendering engines.

Create EPUB with Markdown

Markdown EPUB support via Pandoc is coming soon. In the meantime, you can use AsciiDoc projects for EPUB output.

Reveal.js Presentations

Reveal.js output is available for Markdown documents, allowing you to create browser-based slide presentations. More documentation coming soon.

Mermaid Charts

Mermaid chart rendering is available for Markdown documents, letting you create diagrams and flowcharts using text-based syntax. More documentation coming soon.