.ADOC

Introduction

AsciiDoc is a plain text markup language for documentation and books, first released by Stuart Rackham in 2002. It covers what technical writing needs, such as tables, admonitions, cross references, footnotes and includes, while staying readable as written. Today it is processed mostly by Asciidoctor, and the Eclipse Foundation hosts work on a formal specification.

Files use .adoc, or .asciidoc and older .txt.

Structure

An AsciiDoc file is plain text, normally UTF-8. The document title starts with =, and section titles with ==, === and so on. Lines such as :toc: set attributes, which control output and can be used as variables. *bold* and _italic_ mark text inline. Blocks are set apart by delimiter lines, such as four hyphens for a listing, and can be given a style in square brackets above them, such as [source,python]. Lines like NOTE: start admonitions, and include::chapter.adoc[] pulls in another file.

= User Guide
:toc:

== Installation

Run the installer, then check the version:

[source,console]
----
$ tool --version
----

NOTE: You need *administrator* rights on Windows.

Links