dragonmost/AsciiDoc-CheatSheet

Asciidoc Cheatsheet.^[1]

Table of Contents

• Paragraphs
• Text Formating
• Links
• Headers
• Include Files
• List
• Media
• Button
• Source
• Admonitions
• Delimiters
• Table
• ID, Roles, Options
• Comments
• Attributes
• Text Shorthand
• Reference

Paragraphs

Paragraphs don’t require special markup in AsciiDoc. A paragraph is defined by one or more consecutive lines of text. Newlines within a paragraph are not displayed.

Leave at least one blank line to begin a new paragraph.

To add a new line to a paragraph you need to use "+"
Like this paragraph does

To add a new line to a paragraph
You can also add a %hardbreak attribute

 A literal paragraph.
One or more consecutive lines indented by at least one space.
Literal paragraphs are monospace

Lead paragraph with a larger font.

Text Formating

Bold
Italic
Monospace
Combined
Highlight
Underline
Scratched
Custom theme
^Superscript
_Subscript
“BetterQuotes”

Links

Github
Github

Link to differente part of this documentation Paragraphs.
Link to differente part of this documentation with different name Top.
Link to differente part of this documentation by Id.
Original work[a] containg references

Headers

Header 3^[2]

Header 4

Header 5

Include Files

Resources/Test.adoc

Partial Files

Resources/Test.adoc

Resources/Test.adoc

https://raw.githubusercontent.com/dragonmost/PlebQuest-2.0/master/README.md

List

Unordered List

• Item

  • Nested Item

    • Nested Item

• Item

Ordered List

1. Item

   1. Nested Item

      1. Nested Item

2. Item

Checklist

• ✓ Checked

• ✓ Checked

• ❏ Unchecked

• Not checkable

Description

Text

This is a description

Conclusion

Text

This is a second term

Media

Image

Figure 1. Caption

Audio

Coin sound

Your browser does not support the audio tag.

Video

Street 112

Button

WINDOWS+SHIFT+S
Screenshot

Source

literal line

AsciiDoc required inline literals need to be surrounded by pluses as well as backticks

Literal Block
Uses dots instead

C#

public static void Main(string[] args)
{
    Console.WriteLine("Hello World"); // (1)
}

1. Callout

Source File

link:Source.cs[role=include]

Admonitions

Note	Note Block

Tip

Tip

Important

Important

Warning

Warning

Caution

Caution

Delimiters

Delimiter Block

Mais qu’essez tu voulus tu que je fez.

— Random Hairdresser

Full line break

---

---

---

Page break

Table

Table 1. Title

Header 1	Header 2
Row 1, Col 1	Row 1, Col 2
Row 2, Col 1	Row 2, Col 2

Table 2. Alternative

Header 1	Header 2
Row 1, Col 1	Row 1, Col 2
Row 2, Col 1	Row 2, Col 2

Table 3. Different width

Header 1	Header 2	Header 3

Table 4. CSV Data

Name	Age
Baker	26
Thony	23

Table 5. Merged Cells

1	2	3	4
5	6		7
8
9	10

ID, Roles, Options

Id followed by role and option

Option Block

Shorthand Option Block

Comments

Single line comment using double slash

Multi line comment using quad slash block

Attributes

Index

Index is starting value
counter:index used to increment
1 : 1
2 : 2

Text Shorthand

• ©

• ®

• ™

•  — 

• …​

• →

• ⇒

Reference

• Reference documentation

---

1. AsciiDoctor Syntax Documentation

2. footnote issue