AsciiDoc
AsciiDoctor is a fast text processor and publishing tool for converting AsciiDoc to Html5
This processor is built in Ruby.
There is asciidoc processor available for Javascript as well.
https://github.com/asciidoctor/asciidoctor.js
Asciidoc Setup
-
Install ruby from the below link.
-
Install asciidoc via ruby-gem
The Big Picture
Asciidoctor reads content written in plain text, as shown in the panel on the left in the image below, and converts it to HTML5, as shown rendered in the right panel. Asciidoctor applies a default stylesheet to the HTML5 document to provide a pleasant out-of-the-box experience.
What is AsciiDoc?
AsciiDoc is two things:
-
A mature, plain-text writing format for authoring notes, articles, documentation, books, ebooks, web pages, slide decks, blog posts, man pages and more.
-
A text processor and toolchain for translating AsciiDoc documents into various formats (called backends), including HTML, DocBook, PDF and ePub.
AsciiDoc belongs to the family of lightweight markup languages, the most renowned of which is Markdown. AsciiDoc stands out from this group because it supports all the structural elements necessary for drafting articles, technical manuals, books, presentations and prose. In fact, it’s capable of meeting even the most advanced publishing requirements and technical semantics.
Serving as testament of this fact, many O’Reilly authors including Matthew McCullough, Tim Berglund, Simon St.Laurent, Matt Neuburg and Ian Darwin have used AsciiDoc to write their books for that iconic technical library.
From the very beginning, AsciiDoc was designed to be a shorthand replacement for DocBook, one of the formats AsciiDoc can generate. AsciiDoc can also produce beautiful HTML5, PDFs, eBooks, man pages and even slide decks. It has you covered from first draft to publishing.
Links
AsciiDoctor User manual:
https://asciidoctor.org/docs/user-manual/
Asciidoc Cheatsheet:
https://powerman.name/doc/asciidoc
Asciidoc quick syntax reference:
https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/
Asciidoc vs Markdown:
https://asciidoctor.org/docs/user-manual/