Table of Contents
Markdown
How does markdown on OpenBook work? Let's examine some features.
paragraphs
Paragraphs are separated by a blank line. No blank line means continuing in the same paragraph. Doesn't matter how much text I type.
So this is a new paragraph.
Paragraphs are separated by a blank line. No blank line means continuing in the same paragraph. Doesn't matter how much text I type.
So this is a new paragraph.
bold & italic
*Italic*, **bold**, `monospace`
Italic, bold, monospace
hyperlink
A link on the world wide web: [example.com](http://www.example.com).
A link on the world wide web: example.com.
A local link to the [our Sign In page](/user/sign/in).
A local link to the our Sign In page.
footnote
Create a footnote [^1] like so.
[^1]: Footnote text goes here.
Create a footnote 1 like so.
unordered list
Unordered lists are created by a newline. The actual text -- not considering the asterisk -- starts at 3-columns in.
* this one
* that one
* the other one
Itemized lists are created by a newline, and the actual text -- not considering the asterisk -- starts at 3-columns in.
- this one
- that one
- the other one
ordered list
Here is a ordered list:
1. first item
2. second item
3. third item
Here is a ordered list:
- first item
- second item
- third item
nested lists
A nested list is created by lining text up on at 3-space indents (Note that the last line continues item 3 above).
1. First, get these ingredients:
- carrots
- celery
- lentils
2. Boil some water.
3. Dump everything in the pot and follow
this algorithm:
- find wooden spoon
- manage pot
- uncover pot
- stir
- cover pot
- balance wooden spoon precariously on pot handle
- wait 10 minutes
- goto first step (or shut off burner when done)
* Do not bump wooden spoon or it will fall.
A nested list is created by lining text up on at 3-space indents (Note that the last line continues item 3 above).
First, get these ingredients:
- carrots
- celery
- lentils
Boil some water.
Dump everything in the pot and follow
this algorithm:- find wooden spoon
- manage pot
- uncover pot
- stir
- cover pot
- balance wooden spoon precariously on pot handle
- wait 10 minutes
- goto first step (or shut off burner when done)
- Do not bump wooden spoon or it will fall.
basic table
size | material | color
---- | ------------ | ------------
9 | leather | brown
10 | hemp canvas | natural
11 | glass | transparent
size | material | color |
---|---|---|
9 | leather | brown |
10 | hemp canvas | natural |
11 | glass | transparent |
aligned table
You can specify alignment for each column by adding colons to separator lines. A colon at the left of the separator line will make the column left-aligned; a colon on the right of the line will make the column right-aligned; colons at both side means the column is center-aligned.
| Item | Description | Value|
|:--------- |:-----------:|-----:|
| Computer | Desktop PC |$1600 |
| Phone | iPhone 5s | $12 |
| Pipe | Steel Pipe | $1 |
You can specify alignment for each column by adding colons to separator lines. A colon at the left of the separator line will make the column left-aligned; a colon on the right of the line will make the column right-aligned; colons at both side means the column is center-aligned.
Item | Description | Value |
---|---|---|
Computer | Desktop PC | $1600 |
Phone | iPhone 5s | $12 |
Pipe | Steel Pipe | $1 |
formatted table
Format the content of each cell using regular Markdown syntax:
| Function name | Description |
| ------------- | ------------------------------ |
| `help()` | Display the help window. |
| `destroy()` | **Destroy your computer!** |
Format the content of each cell using regular Markdown syntax:
Function name | Description |
---|---|
help() |
Display the help window. |
destroy() |
Destroy your computer! |
blockquote
> This text will be wrapped in a blockquote-tag
This text will be wrapped in a blockquote-tag
definition
Apple
: Pomaceous fruit of plants of the genus Malus in the family Rosaceae.
Orange
Mandarin
: The fruit of an evergreen tree of the genus Citrus.
- Apple
- Pomaceous fruit of plants of the genus Malus in the family Rosaceae.
- Orange
- Mandarin
- The fruit of an evergreen tree of the genus Citrus.
abbreviation
Create an abbreviation definition like this:
*[HTML]: Hyper Text Markup Language
*[W3C]: World Wide Web Consortium
then, elsewhere in the document, write text such as:
The HTML specification is maintained by the W3C.
Create an abbreviation definition like this:
then, elsewhere in the document, write text such as:
The HTML specification is maintained by the W3C.
closing line
---
code
Create a code block by delimiting with three tildes.
~~~
define foobar() {
print "Welcome to flavor country!";
}
~~~
Alternatively, create the same code block by indenting four spaces.
define foobar() {
print "Welcome to flavor country!";
}
For both of the above, the result is:
define foobar() {
print "Welcome to flavor country!";
}
images
Including images is more complex, because their files need to be uploaded to the OpenBook server, in order to be available to readers.
Images may be centered, or left- or right-aligned. A left aligned image:
~~~

~~~
-
Footnote text goes here. ↩
