From MobileRead
Jump to: navigation, search

AsciiDoc is a text document format for writing notes, documentation, articles, books, ebooks, slideshows, web pages, man pages and blogs.


[edit] Overview

AsciiDoc is a source format using simple TXT that is intended to be easy to write in. Once the content is generated the source files can be translated to many formats including HTML, PDF, EPUB, man page and others using available translation tools.

You write an AsciiDoc document the same way you would write a normal text document, there are no markup tags or weird format notations. AsciiDoc files are designed to be viewed, edited and printed directly or translated to other presentation formats using the asciidoc command.

[edit] How to use

You generate a source file or multiple files using any available text editor. You then use a command line program written in python to compile, convert your document into the final form. Pandoc is one such program that does not require a copy of python.

AsciiDoc is available in tar for Unix (Linux) based systems or as a ZIP file for Windows.

[edit] Supported constructions

  • Headers
  • paragraphs with optional titles.
  • blocks with optional titles, including such things as sidebars, notes, source code.
  • lists
  • tables
  • macros for includes, images, links.
  • // comments
  • {variables} can be defined with value substituted when compiled.

Text can be formatted as needed such as:

  • forced +

line break

  • normal, _italic_, *bold*, +mono+.
  • ``double quoted'', `single quoted'. (using curly quotes)
  • ^super^, ~sub~ (superscript, subscript)
  • \ used to escape the above meanings.

[edit] For more information

  • Cheat Sheet - quick reference guide.
  • A manual is included in the distribution.
  • Git-Scribe - a suite of authoring tools using AsciiDoc for collaboration, translations, copy-editing etc.
  • AFT - almost free text is a similar system using a perl script for the compiler. It can output HTML, Latex, RTF
  • Pandoc can convert AsciiDoc files among other text based formats.
Personal tools

MobileRead Networks