Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
branch: master
Fetching contributors…

Cannot retrieve contributors at this time

92 lines (72 sloc) 2.298 kb
---
asciidoc: |-
AsciiDoc Markup Syntax Summary
==============================
A summary of the most often used markup.
For a complete reference see the 'AsciiDoc User Guide'.
Text formatting
---------------
*bold text* (boldface font)
_emphasized text_ (normally italics)
'emphasized text'
+monospaced text+ (proportional font)
`monospaced text`
Document links
--------------
[[id]] (define link target)
<<id,caption>> (link to target id)
link:filename#id[caption] (link to external HTML file)
URLs
----
Use normal URL and email addess syntax or:
http:address[caption] (link to web page)
mailto:address[caption] (link to mail recipient)
Images
------
image:filename[caption] (inline image)
image::filename[caption] (block image)
Document header
---------------
The Document Title
==================
author <email> (optional)
revision, date (optional)
Section title underlines
------------------------
Level 0 (document title): ======================
Level 1: ----------------------
Level 2: ~~~~~~~~~~~~~~~~~~~~~~
Level 3: ^^^^^^^^^^^^^^^^^^^^^^
Level 4 (bottom level): ++++++++++++++++++++++
Delimited blocks
----------------
Delimiters must begin at left margin.
-------------------
listing block
-------------------
...................
literal block
...................
*******************
sidebar block
*******************
[style, author, cite] (optional)
___________________
quote block
___________________
===================
example block
===================
///////////////////
comment block
///////////////////
More block elements
-------------------
[attributes list] (Note 1)
.Block title (Note 1)
// Comment line (Note 1)
include::filename[] (Note 1)
Note 1: Begin at the left margin.
More inline elements
--------------------
footnote:[footnote text] (document footnote)
Jump to Line
Something went wrong with that request. Please try again.