Markdown Reference
The Markdown language allows you to quickly write web pages without worrying about <h1>
tags and such, allowing you to focus on what you want to say instead of generating HTML. I used Markdown for all Seagrape documentation including this page.
Markdown was invented by John Gruber.
Paragraphs
Create paragraphs by putting blank lines between text.
This is a paragraph.
This is another paragraph.
Headers
Headers are created by using the # symbol. Adding extra #s creates a smaller header.
# Header 1
## Header 2
### Header 3
#### Header 4
##### Header 5
###### Header 6
Emphasizing Text
You can italicize text with *stars*
or _underscores_
.
You can bold text with **two stars**
or __two underscores __
.
You can bold & italicize text with ***three stars***
or ___three underscores ___
.
Bullet Lists
Create a bullet list using stars:
* Beagles
* Squirrels
* Hilarity
Or plus signs:
+ Beagles
+ Squirrels
+ Hilarity
Or minus signs:
- Beagles
- Squirrels
- Hilarity
Numbered Lists
Create a numbered list like this:
1. Beagles
2. Squirrels
3. Hilarity
Links
Hyperlinks
Create a link to your favorite place like this:
[favorite place](https://seagrape.us)
Or you can display the URL https://seagrape.us by using angle brackets:
<https://seagrape.us>
Image Links
An image link is like a hyperlink, but with an exclamation point in front.
!["alt text"](https://seagrape.us/img/drops.jpg "image title")
- “alt text” is shown if the image cannot be displayed.
- “image title” is shown in a popup if the user hovers over the image.
Reference Links
Create a reference link like this:
My favorite search engines are DuckDuckGo and Google.
My favorite search engines are [DuckDuckGo][1] and [Google.][2]
[1]: https://duckduckgo.com/ "DuckDuckGo"
[2]: https://www.google.com/ "Google"
Blockquotes
You can use the > sign on each to indicate quoted text (or code).
> This is blockquote text.
> So is this.
>
> Blockquote paragraphs are created like regular paragraphs.
> Just leave a blank line between sections of text.
Inline Code
Inline code is created by using two back quotes like this: `print message` which results in: print message.
It can be used in a paragraph without breaking up the flow of text.
Footnotes
A flavor of Markdown called Python-Markdown1 can generate footnotes2.
A flavor of Markdown called Python-Markdown[^1] can generate footnotes[^2].
[^1]: This is the first footnote.
[^2]: This is the second footnote.