1
2
3
4
|
namespace
xxoo {
class
ooxx {
}
} |
An h1 header
Paragraphs are separated by a blank line.
2nd paragraph. Italic, bold,
e
- this one
- that one
- the other one
Note that --- not considering the asterisk --- the actual text content starts at 4-columns in.
Block quotes are written like so.
They can span multiple paragraphs, if you like.
Use 3 dashes for an em-dash. Use 2 dashes for ranges (ex. "it‘s all in chapters 12--14"). Three dots ... will be converted to an ellipsis.
An h2 header
Here‘s a numbered list:
- first item
- second item
- third item
Note again how the actual text starts at 4 columns in (4 characters from the left side). Here‘s a code sample:
# Let me re-iterate ...
for i in 1 .. 10 { do-something(i) }
As you probably guessed, indented 4 spaces. By the way, instead of indenting the block, you can use delimited blocks, if you like:
~~~ define foobar() { print "Welcome to flavor country!"; } ~~~
(which makes copying & pasting easier). You can optionally mark the delimited block for Pandoc to syntax highlight it:
~~~python import time
Quick, count to ten!
for i in range(10): # (but not too quick) time.sleep(0.5) print i ~~~
An h3 header
Now a nested list:
-
First, get these ingredients:
- carrots
- celery
- lentils
-
Boil some water.
-
Dump everything in the pot and follow this algorithm:
find wooden spoon 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.
Notice again how text always lines up on 4-space indents (including that last line which continues item 3 above). Here‘s a link to a website. Here‘s a link to a local doc. Here‘s a footnote [^1].
[^1]: Footnote text goes here.
Tables can look like this:
size material color
9 leather brown 10 hemp canvas natural 11 glass transparent
Table: Shoes, their sizes, and what they‘re made of
(The above is the caption for the table.) Here‘s a definition list:
apples : Good for making applesauce. oranges : Citrus! tomatoes : There‘s no "e" in tomatoe.
Again, text is indented 4 spaces. (Alternately, put blank lines in between each of the above definition list lines to spread things out more.)
Inline math equations go in like so: $\omega = d\phi / dt$. Display math should get its own line and be put in in double-dollarsigns:
$$I = \int \rho R^{2} dV$$
Done.
An exhibit of Markdown
This note demonstrates some of what Markdown is capable of doing.
Note: Feel free to play with this page. Unlike regular notes, this doesn‘t automatically save itself.
Basic formatting
Paragraphs can be written like so. A paragraph is the basic block of Markdown. A paragraph is what text will turn into when there is no reason it should become anything else.
Paragraphs must be separated by a blank line. Basic formatting of italics and bold is supported. This can be nested like so.
Lists
Ordered list
- Item 1
- A second item
- Number 3
- Ⅳ
Note: the fourth item uses the Unicode character for Roman numeral four.
Unordered list
- An item
- Another item
- Yet another item
- And there‘s more...
Paragraph modifiers
Code block
Code blocks are very useful for developers and other people who look at code or other things that are written in plain text. As you can see, it uses a fixed-width font.
You can also make
e
Quote
Here is a quote. What this is should be self explanatory. Quotes are automatically indented when they are used.
Headings
There are six levels of headings. They correspond with the six levels of HTML headings. You‘ve probably noticed them already in the page. Each level down uses one more hash character.
Headings can also contain formatting
They can even contain
e
e
Of course, demonstrating what headings look like messes up the structure of the page.
I don‘t recommend using more than three or four levels of headings here, because, when you‘re smallest heading isn‘t too small, and you‘re largest heading isn‘t too big, and you want each size up to look noticeably larger and more important, there there are only so many sizes that you can use.
URLs
URLs can be made in a handful of ways:
- A named link to MarkItDown. The
easiest way to do these is to select what you want to make a link and hit
L
- Another named link to MarkItDown
- Sometimes you just want a URL like http://www.markitdown.net/.
Horizontal rule
A horizontal rule is a line that goes across the middle of the page.
It‘s sometimes handy for breaking things up.
Images
Markdown can also contain images. I‘ll need to add something here sometime.
Finally
There‘s actually a lot more to Markdown than this. See the official introduction and syntax for more information. However, be aware that this is not using the official implementation, and this might work subtly differently in some of the little things.