1. Source Code
1.1. Inline Source Code
|
Copy & Paste Hell! |
class Main {
void main() {
System.out.println("Hello, World!");
}
}
1.2. Included Source Code
|
Why not use the actual sources with highlighting, line numbers, callouts, and skip the file header? |
1
2
3
4
5
6
7
8
class Main {
// tag::main[] (1)
void main() {
System.out.println("Hello, World!");
}
// end::main[] (2)
}
| 1 | // tag::main[] starts a tag named "main" |
| 2 | // end::main[] ends the tag |
Just the method defined with the main the tag and fix indentation:
void main() {
System.out.println("Hello, World!");
}
2. Miscellaneous
3. Lists
-
numbered
-
bulleted
-
one
-
two
-
-
-
with colored symbols
-
▲ positive
-
▶︎ neutral
-
▼ negative
-
-
separate two consecutive lists with
//-.more content for the same item
System.out.println("YAY!");Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer ut odio augue. Nam tristique rhoncus tortor, vitae sollicitudin risus hendrerit.
-
definition lists
-
Question/Answer
-
What is the answer?
42
-
Computer says?
Is it safe?
No.
-
-
on next line
- e.g.
-
for example
Do not confuse with i.e.
- i.e.
-
that is
- et al.
-
and others
-
on same line
small normal large
-
-
includes with parameters
-
Cameron Howe <c.howe@mutiny.com>
-
Joe MacMillan <j.macmillan@calnect.com>
-
4. Tables
4.1. Simple
| First | Last | Money ($) |
|---|---|---|
Homer |
Simpson |
|
Marge |
Simpson |
|
4.2. Inline CSV
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
4.3. Included CSV
| Height | Weight |
|---|---|
15 |
23.4 |
17 |
26.7 |
23 |
45 |
4.4. Cell Content
| Col 1 | Col 2 | ||||
|---|---|---|---|---|---|
Source Code |
|
||||
List |
|
||||
Table in Table |
|