https://github.com/ninjascl/asciidoc-book-template

A Template for Writing Books with Asciidoc
https://github.com/ninjascl/asciidoc-book-template

asciidoc html pdf

Last synced: about 5 hours ago
JSON representation

A Template for Writing Books with Asciidoc

• Host: GitHub
• URL: https://github.com/ninjascl/asciidoc-book-template
• Owner: NinjasCL
• License: other
• Created: 2023-03-05T04:50:06.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-03-05T05:03:43.000Z (over 1 year ago)
• Last Synced: 2023-03-06T23:50:59.748Z (over 1 year ago)
• Topics: asciidoc, html, pdf
• Language: JavaScript
• Homepage: https://ninjascl.github.io/asciidoc-book-template/
• Size: 1.01 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.adoc
  • License: LICENSE

Awesome Lists containing this project

README

        
:fn-ninjas: footnote:[https://ninjas.cl]

= 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 https://github.com/powerman/asciidoc-cheatsheet[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:

- https://docs.asciidoctor.org/diagram-extension/latest/diagram_types/plantuml/[PlantUML]: UML diagrams and C4 architecture diagrams.

- https://docs.asciidoctor.org/diagram-extension/latest/diagram_types/graphviz/[Graphviz]: Generic diagrams tool.

- https://docs.asciidoctor.org/diagram-extension/latest/diagram_types/dbml/[DBML]: Database ERD diagrams (friendlier syntax than PlantUML)

- https://docs.asciidoctor.org/diagram-extension/latest/diagram_types/vega/[Vega]: Declarative language for creating, saving, and sharing interactive visualization designs.

.WIP Diagrams

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

- https://docs.asciidoctor.org/diagram-extension/latest/diagram_types/mermaid/[Mermaid]: Uses Markdown-inspired text definitions and a renderer to create and modify complex diagrams.

- https://docs.asciidoctor.org/diagram-extension/latest/diagram_types/bpmn/[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 https://ninjas.cl[Camilo Castro] and https://github.com/ninjascl/asciidoc-book-template/graphs/contributors[contributors]footnote:[https://github.com/ninjascl/asciidoc-book-template/graphs/contributors]. for https://ninjas.cl[Ninjas.cl]{fn-ninjas}.

This document is licensed with http://creativecommons.org/licenses/by-nc-sa/4.0/[Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International]footnote:[http://creativecommons.org/licenses/by-nc-sa/4.0/]

http://creativecommons.org/licenses/by-nc-sa/4.0/[image:resources/images/by-nc-sa.svg[Licencia Creative Commons]]

Source code licensed with https://opensource.org/licenses/BSD-2-Clause[BSD-2]footnote:[https://opensource.org/licenses/BSD-2-Clause].

## 🤩 Credits

++++



  Made with ♥ by

  

    Ninjas.cl

  .



++++