This is a PREAMBLE.
Prerequisite
-
item 1
-
item 2
-
item 2.1
-
Asciidoc always create a #toc id.
Reference here
Check the raw file to see how this is done.
Create paragraphs by separating them with a blank line.
Create a monospaced paragraph by preceding it with one space.
Hard lines break 1 followed by
line 2 at the same level.
This text is crossed out
superscript
subscript
It has strong significance to me.
I cannot stress this enough.
Type OK to accept.
That really has to go.
Can’t pick one? Let’s use them all.
Normal line.
Indent line by one space to create a literal line.
Normal line.
Output literal monospace text, such as {backtick} or http://localhost:8080, by enclosing the text in a pair of pluses surrounded by a pair backticks.
Write [command]`test` outputs test
Literal block is enclosed with ....
let randomNumber = Math.floor(Math.random() * 100) + 1;
let guesses = document.querySelector(".guesses");
let lastResult = document.querySelector(".lastResult");
let lowOrHi = document.querySelector(".lowOrHi");
let guessSubmit = document.querySelector(".guessSubmit");
let guessField = document.querySelector(".guessField");
let guessCount = 1;
let resetButton;The markdown syntax to write code works too.
require 'sinatra' // (1)
get '/hi' do // (2)
"Hello World!" // (3)
end-
Library import
-
URL mapping
-
HTTP response body
- collapsible block example
-
Click to reveal the answer
This is the answer.
https://docs.asciidoctor.org/asciidoc/latest/macros/links/[link manual] >
link manual
Custom ID doesn’t work in github. To use a cross reference use its name <<First section level 1>> >
[First section level 1]
|
ℹ️
|
An admonition draws the reader’s attention to auxiliary information. |
Here are the other built-in admonition types:
|
❗
|
Don’t forget the children! |
|
💡
|
Look for the warp zone under the bridge. |
|
🔥
|
Slippery when wet. |
|
|
The software you’re about to use is untested. |
|
ℹ️
|
An admonition block may contain complex content. A list
Another paragraph. |
Four score and seven years ago our fathers brought forth on this continent a new nation…
Address delivered at the dedication of the Cemetery at Gettysburg
- First term
-
The description can be placed on the same line as the term.
- Second term
-
Description of the second term. The description can also start on its own line.
-
❏ not checked
-
normal list item
-
-
What is the answer?
This is the answer.
-
Are cameras allowed?
Are backpacks allowed?
No.
- Operating Systems
-
- Linux
-
-
Fedora
-
Desktop
-
-
Ubuntu
-
Desktop
-
Server
-
-
- BSD
-
-
FreeBSD
-
NetBSD
-
- Cloud Providers
-
- PaaS
-
-
OpenShift
-
CloudBees
-
- IaaS
-
-
Amazon EC2
-
Rackspace
-
-
Every list item has at least one paragraph of content, which may be wrapped, even using a hanging indent.
Additional paragraphs or blocks are adjoined by putting a list continuation on a line adjacent to both blocks.
- list continuation
-
a plus sign (
+) on a line by itself
-
A literal paragraph does not require a list continuation.
$ cd projects/my-book
-
AsciiDoc lists may contain any complex content.
Column 1, Header Row Column 2, Header Row Column 1, Row 1
Column 2, Row 1
++++ <p> Content in a passthrough block is passed to the output unprocessed. That means you can include raw HTML, like this embedded Gist. Github support is limited. No CSS supported. Only basic html tags. </p> ++++
underline me is underlined.
underline me is also underlined.
| Column 1, Header Row | Column 2, Header Row |
|---|---|
Cell in column 1, row 1 |
Cell in column 2, row 1 |
Cell in column 1, row 2 |
Cell in column 2, row 2 |
| Name of Column 1 | Name of Column 2 |
|---|---|
Cell in column 1, row 1 |
Cell in column 2, row 1 |
Cell in column 1, row 2 |
Cell in column 2, row 2 |
| Name | Category | Description |
|---|---|---|
Firefox |
Browser |
Mozilla Firefox is an open source web browser. It’s designed for standards compliance, performance, portability. |
Arquillian |
Testing |
An innovative and highly extensible testing platform. Empowers developers to easily create real, automated tests. |
Firefox |
Browser |
Mozilla Firefox is an open source web browser. It’s designed for:
|
| Artist | Track | Genre |
|---|---|---|
Baauer |
Harlem Shake |
Hip Hop |
1 |
2 |
3 |
4 |
5 |
|
|
|
8 |
|||
9 |
|
||
-
Goal 1
-
Goal 2
monospace text
free the world
To chekc the custom ID’s for the elements above, open the devtool. Ignore the user-content prefix added by github when you want to reference the custom ID’s.
// A single-line comment //// A multi-line comment. Notice it's a delimited block. ////
Check out Asciidoctor!
AsciiDoc is a mature, plain-text document format for writing notes, articles, documentation, books, and more. It’s also a text processor & toolchain for translating documents into various output formats (i.e., backends), including HTML, DocBook, PDF and ePub.
Be sure to read the documentation too!
[✔] That’s done!