Asciidoc Book Template

This is an example template for making Asciidoc books.

An example output can be seen online at https://ninjascl.github.io/asciidoc-book-template/.

You can learn with Asciidoc Cheatsheet.

Technology

• https://www.docker.com/

• https://docs.asciidoctor.org/

• Python3 (Webserver)

• https://pandoc.org/ (Conversion to multiple formats)

Diagrams

Using the base Dockerfile for https://docs.asciidoctor.org/diagram-extension/latest/

The following technologies were selected for diagrams:

• PlantUML: UML diagrams and C4 architecture diagrams.

• Graphviz: Generic diagrams tool.

• DBML: Database ERD diagrams (friendlier syntax than PlantUML)

• Vega: Declarative language for creating, saving, and sharing interactive visualization designs.

WIP Diagrams

These need extra configurations inside the Dockerfile to Work (Puppeteer).

• Mermaid: Uses Markdown-inspired text definitions and a renderer to create and modify complex diagrams.

• BMPN: Business Process Model and Notation.

Commands

• make install: Builds the Dockerfile.

• make html: Builds the html version of the book.

• make pdf: Builds a PDF version of the book.

• make server: Starts a new server for the html version. (requires python3).

• make word: Creates a new Microsoft Word document from the book. (requires pandoc).

License

Created with ❤️ by Camilo Castro and contributors^[1]. for Ninjas.cl^[2].

This document is licensed with Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International^[3]

Source code licensed with BSD-2^[4].

🤩 Credits

Made with ♥ by Ninjas.cl .

---

1. https://github.com/ninjascl/asciidoc-book-template/graphs/contributors

2. https://ninjas.cl

3. http://creativecommons.org/licenses/by-nc-sa/4.0/

4. https://opensource.org/licenses/BSD-2-Clause