Headings from h1 through h6 are constructed with a # for each level:
Unofficial
- TaskDone
- TaskNotDone
Unofficial This tests single line break
--- Three consecutive en-dashes
Bold rendered as bold text
Italics rendered as italicised text
Unofficial
Strikethrough
Strike through this text.
Blockquotes
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante. This is a blockquote.
Unordered
A list of items in which the order of the items does not explicitly matter.
You may use any of the following symbols to denote bullets for each list item:
- valid bullet
- valid bullet
- valid bullet
- More
Nesting:
- Lorem ipsum dolor sit amet
- Consectetur adipiscing elit
- Nulla volutpat aliquam velit
- Phasellus iaculis neque
- Purus sodales ultricies
- Faucibus porta lacus fringilla vel
- Aenean sit amet erat nunc
Ordered
A list of items in which the order of items does explicitly matter.
- Lorem ipsum dolor sit amet
- Consectetur adipiscing elit
TIP: If you just use 1. for each number, GitHub will automatically number each item. For example:
- Lorem ipsum dolor sit amet
- Consectetur adipiscing elit
- Integer molestie lorem at massa
Unofficial
Single-line code:
Use single apostrophes for one line.
Use “code fences” ``` to block in multiple lines of code.
<h5 style="color:blue;">This is unrendered code in monospace and a selected language format...</h5> class Queue[T](
private val leading: List[T],
private val trailing: List[T]
) {
private def mirror =
if (leading.isEmpty)
new Queue(trailing.reverse, Nil)
else
this
def head = mirror.leading.head
def tail = {
val q = mirror
new Queue(q.leading.tail, q.trailing)
}
def append(x: T) =
new Queue(leading, x :: trailing)
}ABCDEFGHIJKLM
NOPQRSTUVWXYZ
abcdefghijklm
nopqrstuvwxyz
1234567890
Tables are created by adding pipes as dividers between each cell, and by adding a line of dashes (also separated by bars) beneath the header. Note that the pipes do not need to be vertically aligned.
| Option | Description |
|---|---|
| data | path to data files to supply the data that will be passed into templates. |
| engine | engine to be used for processing templates. Handlebars is the default. |
| ext | extension to be used for dest files. |
Right aligned text
Adding a colon on the right side of the dashes below any heading will right align text for that column.
| Option | Description |
|---|---|
| data | path to data files to supply the data that will be passed into templates. |
| engine | engine to be used for processing templates. Handlebars is the default. |
| ext | extension to be used for dest files. |
Basic link
[Upstage](https://github.com/upstage/ “Visit Upstage!”)
Unofficial
Named anchors enable you to jump to the specified anchor point on the same page. For example, each of these chapters:
Content for chapter one.
Content for chapter one.
Content for chapter one. Specific placement of the anchor tag seems to be arbitrary. They are placed inline here since it seems to be unobtrusive, and it works.
Unofficial
Images have a similar syntax to links but include a preceding exclamation point.
