mirror of
https://github.com/yuriskinfo/cheat-sheets.git
synced 2025-12-24 14:31:49 +01:00
60 lines
1.4 KiB
Plaintext
60 lines
1.4 KiB
Plaintext
= Asciidoc syntax cheat sheet
|
|
:author: Yuri Slobodyanyuk
|
|
|
|
Author: Yuri Slobodyanyuk, admin@yurisk.info
|
|
|
|
[cols=2,options="header"]
|
|
|===
|
|
|
|
|Command
|
|
|Description
|
|
|
|
|
|
|`article, book, manpage`
|
|
|Types of AsciiDoc documents
|
|
|
|
|Block types
|
|
a| Document ::= (Header?, Preamble?, Section*) +
|
|
Header ::= (Title, (AuthorInfo, RevisionInfo?)?) +
|
|
AuthorInfo ::= (FirstName, (MiddleName?, LastName?)?, EmailAddress?) +
|
|
RevisionInfo ::= (RevisionNumber?, RevisionDate, RevisionRemark?) +
|
|
Preamble ::= (SectionBody) +
|
|
SectionBody ::= ((BlockTitle?, Block) \| (BlockMacro)+ +
|
|
Block ::= (Paragraph \| DelimitedBlock \| List \| Table) +
|
|
List ::= (BulletedList \| NumberedList \| LabeledList \| CalloutList) +
|
|
BulletedList ::= (ListItem)+ +
|
|
NumberedList ::= (ListItem)+ +
|
|
CalloutList ::= (ListItem)+ +
|
|
LabeledList ::= (ListItem)+ +
|
|
ListEntry ::= (ListLabel, ListItem) +
|
|
ListLabel ::= (ListTerm+) +
|
|
ListItem ::= (ItemText, (List \| ListParagraph \| ListContinuation)*)
|
|
|
|
|\_text_
|
|
|_text_ will be in italics.
|
|
|
|
|\*some text*
|
|
|*some text* will be bold/strong.
|
|
|
|
|\+some text+
|
|
|+some text+ will be in Monospace.
|
|
|
|
|
|
|\`some text`
|
|
|`some text` is rendred not just in Monospace but literally.
|
|
|
|
|\"`some text`"
|
|
|"`some text`" will be in double smart quotes.
|
|
|
|
|
|
|\'`some text`'
|
|
|'`some text`' will be rendered in single smart quotes.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|===
|