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: Tygocage Tojagul
Country: Saint Lucia
Language: English (Spanish)
Genre: Career
Published (Last): 4 February 2010
Pages: 61
PDF File Size: 20.79 Mb
ePub File Size: 3.56 Mb
ISBN: 256-4-68054-515-3
Downloads: 44337
Price: Free* [*Free Regsitration Required]
Uploader: Mobei

Used to generate roff format UNIX manual pages. The tabsize macro attribute sets the number of space characters to be used for tab expansion in the included file not applicable to include1 macro. An example slidy slideshow and the AsciiDoc source. For example, the following three section titles are functionally equivalent:.

Just be sure to include the index.

AsciiDoc Cheat Sheet

Definition 4 Term 4. Upper case roman numbered list item. This is a second example paragraph in AsciiDoc. By default html4 top level sections are separated by a horizontal ruler element, undefine this attribute or set it to an empty string if you do not want them. Another list or a literal paragraph immediately following a list item will be implicitly included in the list item; use list item continuation to explicitly append other block elements to a list item.

Absolute or relative directory name.

Delimited blocks are blocks ceat text enveloped by leading and trailing delimiter lines normally a series of four or more repeated characters. Auto-magical special section titles have the following drawbacks: If you want to group your chapters into parts, you can do so by creating a new asciidoc file for example, part1. To learn how to add inline markup such as italics to your text see the Inline Markup section.

Adds a table of contents to the start of an article or book document. Get the URL for your new repo from the Settings tab.

The encoding attribute can be set using an AttributeEntry inside the document header. See this AsciiDoc discussion group thread for details. Matt has written an article describing how he used AsciiDoc and other tools to hseet the book. The reality is that tables are seldom used, even in technical documentation. DocGist also features a real-time collaboration mode. A Block macro reference must be contained in a single line separated either side by a blank line or a block delimiter.


Use the max-width attribute to change the content width. If you are going the DocBook route then the a2x 1 –no-icons and –icons-dir options can be used to set the appropriate XSL Stylesheets parameters.

When toc-placement is set to manual the TOC can be positioned anywhere in the document by placing the toc:: The text of the quote itself should appear immediately below, with four underscore characters above and below it. To find out more about man pages view the man 7 manpage man 7 man and man man-pages commands. AsciiDoc defines standard DocBook book frontmatter and backmatter section markup templates appendix, dedication, preface, bibliography, glossary, index, colophon.

To include an external code file that is text-only chwat inline markup besides calloutsuse the include:: The configuration file [footer] template section is substituted and written to the output file. The revision remark extends from the colon up to the next blank line, attribute entry or comment and is subject to normal text substitutions. If the list contains any named or quoted attributes then all string attribute values must be quoted.

Backend aliases are alternative names for AsciiDoc backends. Horizontal labeled list style The horizontal labeled list style asciidooc the first positional attribute places the list text side-by-side with the label instead of under the label. This optional entry specifies an executable shell command for processing block content Paragraphs, DelimitedBlocks and Tables.

AsciiDoc User Guide

Uzbek by Painting Valley. This backend generates HTML 5 markup, apart from the inclusion of audio and video block macros it is functionally identical to the xhtml11 backend. The list consists of zero or more positional attribute values followed by zero or more named attribute values.


All three are optional, but if they are used they must appear assciidoc the document header or on the command-line. The entries that translate to blank strings are designed to be used for conditional text inclusion. asciifoc

Embedded files are automatically inserted in the output files but you need to manually copy linked CSS and Javascript files from AsciiDoc configuration directories to the correct location relative to the output document.

For example, the following line: Here is an example: You have divided your AsciiDoc document into separate cheeat one per top level section which are combined and processed with the following top level document:. The first line must start hard against the left margin no intervening white space.

The WikiMatrix website has an excellent web page that compares the various Wiki markup syntaxes. When the title text matches a configuration file [specialsections] entry.

The open block delimiter is line ccheat two hyphen characters instead of four or more repeated characters.

To do this, just add the descriptive text in quotes inside the brackets, which are at the end of the image markup:. Multi-item style parameters subspresubspostsubsposattrs must be specified using Python tuple syntax rather than a simple list of asciidpc as they in separate entries e.

AsciiDoc User Guide

Saciidoc block is treated as a comment see CommentBlocks. Attribute entries in the document Header are available for header markup template substitution. To print a help topic specify the topic name as a command argument.

Back to top