asciidoc cheat sheet. GitHub Gist: instantly share code, notes, and snippets. `Inline code`. Inline code. [source,java] /** * @author John Smith */ package ; public. Description. A text document format for writing notes, documentation, articles, books, ebooks, slideshows, web pages, man pages and blogs.

Author: Doubei Tugar
Country: Georgia
Language: English (Spanish)
Genre: Career
Published (Last): 8 August 2009
Pages: 183
PDF File Size: 17.37 Mb
ePub File Size: 6.9 Mb
ISBN: 551-8-78006-306-6
Downloads: 53590
Price: Free* [*Free Regsitration Required]
Uploader: Sarn

A preface file should begin with the word preface in single brackets, followed on the next line by two equals signs and the preface title:. Labeled 2 Term 1 Definition 1 Sheft 1. Macro Definitions Each entry in the configuration [macros] section is a macro definition which can take one of the following forms: A style is a set of block parameter bundled ascciidoc a single named parameter.

Header The Header contains document meta-data, typically title plus optional authorship and revision information: The fishR website has a number of book examples written using AsciiDoc. Attribute entries in the document Header are available for header markup template substitution.

If the expression evaluates to True the attribute evaluates to an empty string.

To mark a partial word in constant width, or a word that abuts a non-whitespace character, double up the plus signs on either side of the text, like this: Used to generate roff format UNIX manual pages. The mechanism to implement color and text decorator attributes is provided for DocBook toolchains via the DocBook phrase element role attribute, but the actual rendering is toolchain specific and is not part of the AsciiDoc distribution.


When the input is being read from the standard input stdin these attributes are undefined. Atlas supports math equations set as LaTeX.

AsciiDoc Home Page

Ssheet books with multiple contributors, you may want an author name to appear with each chapter. Name Backends Description id html4, html5, xhtml11, docbook Unique identifier typically serve as link targets.

Cell alignments are ignored for verseliteral or asciidoc table styles. Inline macros are replaced by the contents of parametrized configuration file sections. Used to calculate CALS tables absolute cheaf and table widths. If you are familiar with DocBook you will have noticed that AsciiDoc document types correspond to the same-named DocBook document types.

Normally used to create a vertical header in the first column.

Text quoted with single backtick characters constitutes an inline literal passthrough. LaTeX asciidic can be included in documents that are processed by dblatex 1. Constrained quotes Quoted must be bounded by white space or commonly adjoining punctuation characters. Inline Macros Inline Macros occur in an inline element context. The include and include1 system macros to include the contents of a named file into the source document.

Getting Started

The optional width and height attributes scale the image size and can be used in any combination. Here a some examples of author information lines:. Section markup templates specify output markup and are defined in AsciiDoc configuration files.

This allows a single level of table nesting.

Specifying special section template names explicitly does add more noise to the source document the template attribute declarationbut the intention is obvious and the syntax is consistent with other AsciiDoc elements c.


Current PDF toolchains do not make a good job of determining the relative column widths for horizontal labeled lists. See attribute options for a complete list of available options. asciidox

AsciiDoc Home Page

The part titles in multi-part books are top level titles same level as book title. Generating Plain Text Files AsciiDoc does not have a text backend for most purposes AsciiDoc source text is finehowever you can convert AsciiDoc text files to formatted text using the AsciiDoc a2x 1 toolchain wrapper utility.

CSS rules for text color, text background color, text size and text decorators are included in the distributed AsciiDoc CSS files and are used in conjunction with AsciiDoc xhtml11html5 and docbook outputs.

The Configuration Files section explains how to add and replace special words. The output will include callouts numbers in the code, followed by a numbered list, as shown here:. Pacmanthe Arch Linux package manager, has been documented using AsciiDoc. Section underlines consist a repeated character pairs spanning the width of the preceding title give or take up to two characters: The pipe character is substituted for the block contents.