AsciiDoc User GuideStuart Rackham<srackham@gmail.com> Table of Contents
JavaScript must be enabled in your browser to display the table of contents. AsciiDoc is a text document format for writing documentation, articles, manuals, books and UNIX man pages. AsciiDoc files can be translated to HTML and DocBook markups using the asciidoc(1) command. AsciiDoc is highly configurable: both the AsciiDoc source file syntax and the backend output markups (which can be almost any type of SGML/XML markup) can be customized and extended by the user. IntroductionThis is an overly large document, it probably needs to be refactored into a Tutorial, Quick Reference and Formal Reference. If you're new to AsciiDoc read this section and the Getting Started section and take a look at the example AsciiDoc (*.txt) source files in the distribution doc directory. Plain text is the most universal electronic document format, regardless of your computing environment you can always read and write plain text documentation. But for many applications plain text is not the preferred presentation format — HTML and PDF formats are widely used as is the roff man page format. DocBook is a popular documentation markup format which can be translated to HTML, PDF and other presentation formats.
Last updated 2010-05-10 20:23:14 BST
|
Keith Burdis >