== AsciiDoc Format -> Level 1 Header === Headers -> Level 2 Header ==== Level 3 Header ...
Source
== AsciiDoc Format -> Level 1 Header === Headers -> Level 2 Header ==== Level 3 Header ...
Render
Create an anchor to a header so it can be accessed quickly.
Source
[[test-anchor]] === Test Anchor
Render
Create a link to the previously created anchor.
Source
<<test-anchor, Header>>
Render
Use bold font for a word.
Source
*word*
Render
word
Use bold font for a part of a word.
Source
w**or**d
Render
word
Use style italics for a word.
Source
_word_
Render
word
Use style italics for part of a word.
Source
w__or__d
Render
word
Give emphasis to a word.
Source
Give emphasis to a _word_
Render
word
Place a word in single quotes.
Source
'`word`'
Render
‘word’
Place a word in double quotes.
Source
"`word`"
Render
“word”
Place a word, or part of a word, as a superscript.
Source
^super^script
Render
superscript
Place a word, or part of a word, as a subscript
Source
~wo~rd
Render
word
Use monospaced font.
Source
`word`
Render
word
Break a line in the same paragraph.
Source
This idea ends here. + And I want this one in a new line, but in the same paragraph.
Render
This idea ends here.
And I want this one in a new line,
but in the same paragraph.
Use the backslash (\) to escape special characters.
Source
\*word* (Normally, it would make the word bold.)
Render
*word*
Use two slashes (//) to comment in the text and do not render it in the HTML.
Source
The next line is a comment. // It should not be rendered in the HTML.
Render
The next line is a comment.
Delimit HTML code in 4
plus (+)
to execute it once rendered.
Since the idea of Pelican is to separate content from style,
do not use this method.
Focus only on content in the .adocs
.
Source
++++ <p style="color:green"> This <I>HTML</I> code will be rendered directly to the page.<br> </p> ++++
Render
This HTML code will be rendered directly to the page.
Source
(C), (R), (TM)
Render
©, ®, ™
They are declared before an element,
starting with a dot
(images
, lists
, quotes
, literals
, etc.).
Source
.Image Title image::doge.png[Doge]
Render
Source
.Video Title video::he-man.mp4[He-man]
Render
Source
.Literal Title .... Literal Block ....
Render
Literal block
Source
.List Title . Item 1 .. Subitem 1 . Item 2
Render
Item 1
Subitem 1
Item 2
Source
.Quote Title [quote] I'm Batman
Render
I’m Batman
Source
.Table Title |==== | Col 1 | Col 2 |====
Render
Col 1 |
Col 2 |
Source
.Paragraph Title Normal Paragraph
Render
Normal Paragraph
Source
.Code Title [source, python] print "Hello World"
Render
print "Hello World"
Source
image::doge.png[Doge]
Render
Block Image
Source
image:doge.png[Doge]
Render
Inline Image
Source
video::he-man.mp4[He-man]
Render
When this option is being used, every punctuaction mark goes outside of the square brackets ``[]''.
Source
link:https://google.com[Google].
Render
Source
[button]#link:https://google.com[Google]#.
Render
.
A literal block is delimited by 4 dots before and after the content.
Source
.... Hello ....
Render
Hello
Set a blank space as the first character of a line.
Source
{space}Hello
Render
Hello
Source
[quote] I'm Batman
Render
I’m Batman
Source
[quote, Batman, Detective Comics] I'm Batman
Render
I’m Batman
Source
.Code.py [source, python] print "Hello World"
Render
print "Hello World"
Source
.Code.java [source, java, linenums] ---- Line 1 Line 2 Line 3 ----
Render
Line 1
Line 2
Line 3
If there are multiple code blocks with numbered lines, the numbering will be organized sequentially.
Source
.Code.cpp [source, cpp, linenums] ---- Line 1 Line 2 Line 3 ---- + [source, cpp, linenums] ---- Line 4 Line 5 Line 6 ----
Render
Line 1
Line 2
Line 3
Line 4
Line 5
Line 6
![]() |
In order to reset the numbering, a title must be given to the desired code block. |
Source
.Code1.py [source, python, linenums] ---- Line 1 Line 2 Line 3 ---- + .Code2.py [source, python, linenums] ---- Line 1 Line 2 Line 3 ----
Render
Line 1
Line 2
Line 3
Line 1
Line 2
Line 3
The path to the file must be absolute
and according to the container’s filesystem.
In the source,
there must not be a space
between the path and the square brackets.
The space was placed,
so the file was not rendered
in the literal block.
Source
.Code from file [source, gherkin, linenums] ---- include::script.feature [] -> No space ----
Render
Feature: Make coffee
Coffee should brew after mixing the ingredients
Background:
Given a cofee pot
And coffee beans
And water
Scenario: Make coffee from scratch
When I grind the coffee
Then I can put in in the pot
When I put the cofee and water in the pot
When I turn it on
Then coffee should brew
Source
. Item 1 + .Code1.py [source, python] ---- print "Hello World" ---- . Item 2 + .Code2.py [source, python] ---- print "Bye World" ----
Render
Item 1
print "Hello World"
Item 2
print "Bye World"
Source
* Item 1 - Subitem 1.1 ** Subitem 1.2
Render
Item 1
Subitem 1.1
Subitem 1.2
Source
. Item 1 .. Item 1.1 ... Item 1.1.1 .. Item 1.2 ... Item 1.2.1 .... Item 1.2.1.1 . Item 2
Render
Item 1
Item 1.1
Item 1.1.1
Item 1.2
Item 1.2.1
Item 1.2.1.1
Item 2
Source
. Something about a topic + Still talking about the same topic . Another Topic Talking about something else
Render
Something about a topic
Still talking about the same topic
Another Topic
Talking about something else
Source
.Title [options="header"] -> Optional |==== |Col 1|Col 2 |Col 3 |1 |Item 1 |a |2 |Item 2 |b |3 |Item 3 |c |6 |Three items|d |====
Render
Col 1 | Col 2 | Col 3 |
---|---|---|
1 |
Item 1 |
a |
2 |
Item 2 |
b |
3 |
Item 3 |
c |
6 |
Three items |
d |
Source
[grid="rows",format="csv"] [options="header",cols="^,<,<s,<,>m"] |==== ID,FName,LName,Address,Phone 1,Vasya,Pupkin,London,+123 2,X,Y,"A,B",45678 |==== grid -> Sets borders format -> Sets the delimiter character between columns header -> The first column are headers cols -> Sets format of the columns ^ align center in the row < align left in the row <s align left in the row and font strong (bold) >m align right in the row and font monospaced The CSS of the site overrides some of the previous.
Render
ID | FName | LName | Address | Phone |
---|---|---|---|---|
1 |
Vasya |
Pupkin |
London |
|
2 |
X |
Y |
A,B |
|
Source
.Multiline cells, row/col span [caption="Tabla"] |==== |Date |Duration |Avg HR |Notes |22-Aug-08 .2+^.^|10:24 | 157 | Worked out MSHR (max sustainable heart rate) by going hard for this interval. |22-Aug-08 | 152 | Back-to-back with previous interval. |24-Aug-08 3+^|none |==== .2+^.^ -> Occupy two cells vertically and align center horizontally and vertically 3+^ -> Occupy 3 cells horizontally and align center horizontally A dot (.) represents columns
Render
Date | Duration | Avg HR | Notes |
---|---|---|---|
22-Aug-08 |
10:24 |
157 |
Worked out MSHR (max sustainable heart rate) by going hard for this interval. |
22-Aug-08 |
152 |
Back-to-back with previous interval. |
|
24-Aug-08 |
none |
Use the special class tb-row
for this type of table.
DO NOT USE MULTILINE CELLS.
Source
[role="tb-row"] .Horizontal Distribution [frame="topbot", cols="^s,^,^"] |==== | Row 1 | Item 1 | Item 2 | Row 2 | Item 1 | Item 2 | Row 3 | Item 1 | Item 2 |====
Render
Row 1 | Item 1 | Item 2 |
---|---|---|
Row 2 |
Item 1 |
Item 2 |
Row 3 |
Item 1 |
Item 2 |
Source
[role="tb-row"] .Horizontal Distribution - More Cols than Rows |==== >m| Row 1 | Item 1 | Item 2 | Item 3 | Item 4 ^s| Row 2 | Item 1 | Item 2 | Item 3 | Item 4 | Row 3 | Item 1 | Item 2 | Item 3 | Item 4 |====
Render
Row 1 | Item 1 | Item 2 | Item 3 | Item 4 |
---|---|---|---|---|
Row 2 |
Item 1 |
Item 2 |
Item 3 |
Item 4 |
Row 3 |
Item 1 |
Item 2 |
Item 3 |
Item 4 |
Use the special class `tb-col”` for this type of table. *DO NOT USE MULTILINE CELLS*.
Source
[role="tb-col"] .Vertical Distribution - NxN [options="header", cols="^,^,^"] |==== | Col 1 | Col 2 | Col 3 | Item 1.1 | Item 1.2 | Item 1.3 | Item 2.1 | Item 2.2 | Item 2.3 |====
Render
Col 1 | Col 2 | Col 3 |
---|---|---|
Item 1.1 |
Item 1.2 |
Item 1.3 |
Item 2.1 |
Item 2.2 |
Item 2.3 |
Source
[role="tb-col"] .Vertical Distribution - MxN, M < N [cols="<,^,>,<"] |==== s| Col 1 s| Col 2 s| Col 3 s| Col 4 | Item 2.1.1 | Item 2.1.2 | Item 2.1.3 | Item 2.1.4 | Item 2.2.1 | Item 2.2.2 | Item 2.2.3 | Item 2.2.4 |====
Render
Col 1 | Col 2 | Col 3 | Col 4 |
---|---|---|---|
Item 2.1.1 |
Item 2.1.2 |
Item 2.1.3 |
Item 2.1.4 |
Item 2.2.1 |
Item 2.2.2 |
Item 2.2.3 |
Item 2.2.4 |
Source
[role="tb-col"] .Vertical Distribution - MxN, M > N |==== | Col 1 | Col 2 | Col 3 | Item 2.1.1 | Item 2.1.2 | Item 2.1.3 | Item 2.2.1 | Item 2.2.2 | Item 2.2.3 | Item 2.3.1 | Item 2.3.2 | Item 2.3.3 | Item 2.4.1 | Item 2.4.2 | Item 2.4.3 | Item 2.5.1 | Item 2.5.2 | Item 2.5.3 |====
Render
Col 1 | Col 2 | Col 3 |
---|---|---|
Item 2.1.1 |
Item 2.1.2 |
Item 2.1.3 |
Item 2.2.1 |
Item 2.2.2 |
Item 2.2.3 |
Item 2.3.1 |
Item 2.3.2 |
Item 2.3.3 |
Item 2.4.1 |
Item 2.4.2 |
Item 2.4.3 |
Item 2.5.1 |
Item 2.5.2 |
Item 2.5.3 |
Use the special class tb-alt
for this type of table.
DO NOT USE MULTILINE CELLS.
Source
[role="tb-alt"] .Table with Alternated Content [cols="2*^", frame="none"] |==== |Text 1 |image:doge.png[Doge] |image:doge.png[Doge] |Text 2 |Text 3 |image:doge.png[Doge] |image:doge.png[Doge] |Text 4 |====
Render
Text 1 |
|
Text 2 |
|
Text 3 |
|
Text 4 |
[qanda] Question 1:: Answer 1 Question 2:: Answer 2
Render
Question 1
Answer 1
Question 2
Answer 2
Source
Term 1:: Definition Term 2:: Definition [horizontal] Subterm 2.1::: Definition can also be placed horizontally
Render
Definition
Definition
Subterm 2.1 |
Definition can also be placed horizontally. |
Source
[WARNING] The speed limit in this road is 60 mph. + Do not exceed this speed. NOTE: I left the dinner in the oven. [CAUTION] Be careful! The floor is slippery! TIP: You can also make an appointment via our website. [IMPORTANT] Be sure to get all of your belongings before exiting the vehicle.
Render
![]() |
The speed limit in this road is 60 mph. Do not exceed this speed. |
![]() |
I left the dinner in the oven. |
![]() |
Be careful! The floor is slippery! |
![]() |
You can also make an appointment via our website. |
![]() |
Be sure to get all of your belongings before exiting the vehicle. |
Source
'''
Render
They can be declared at the beginning of the document.
Source
:variable: AsciiDoc This text is written in {variable}.
Render
This text is written in AsciiDoc.
As with colors,
inline elements can be given a class name
and then be edited in the CSS
.
Source
[new-class]#element#
Render
element
Block elements can also be given class names.
Source
[role="new-class"] ---- Text ----
Render
Text
Source
Term image:{tooltip}[alt="Tooltip icon",title="Additional information about the term"] Term2 image:{tooltip}[alt="Tooltip icon",title="The description can have line breaks in the source code"]
Render
Term
Term2
Copyright © 2021 Fluid Attacks, We hack your software. All rights reserved.