Hawkee Flavored Markdown

By Hawkee on Oct 02, 2014

Hawkee uses the most common form of Markdown with many GitHub elements such as fenced code and tables. Here are some examples to help you create more clear and easy to understand pages.

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. These can be nested like so.

Markdown

*italics*
**bold**
~~strikethrough~~
*italics **with nested bold** is possible*

Blockquotes

Here is a quote.
Quotes are automatically indented when they are used.

Markdown

> Here is a quote.
> Quotes are automatically indented when they are used.

Horizontal rule


A horizontal rule is a line that goes across the middle of the page.

Markdown

---

Lists


Ordered list

  1. Item 1
  2. A second item
  3. Number 3

Markdown

1. Item 1
2. A second item
3. Number 3
4. Ⅳ

Unordered list

  • An item
  • Another item
  • Yet another item
  • And there's more...

Markdown

* An item
* Another item
* Yet another item
* And there's more...

Code


Code needs to be surrounded by 3 tick marks before the first line and after the last line of code. You may also follow the ticks with a language before the code to indicate the language to highlight.

print "Hello world!";

Markdown


```
print "Hello world!";

```

You can also make inline code with single ticks surrounding the code.

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.

Heading 1

Heading 2

Heading 3

Heading 4

Heading 5
Heading 6

Markdown

# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6
### Headings *can* also contain **formatting**
### They can even contain `inline code`

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][3]. The easiest way to do these is to select what you want to make a link and hit Ctrl+L.
  • Another named link to MarkItDown
  • Sometimes you just want a URL like http://www.markitdown.net/.

Markdown

* A named link to [MarkItDown][3]. The easiest way to do these is to select what you want to make a link and hit `Ctrl+L`.
* Another named link to [MarkItDown](http://www.markitdown.net/)
* Sometimes you just want a URL like <http://www.markitdown.net/>.

Tables


Tables will automatically fill the width of the screen and are created with a combination of pipes (|) and dashes (-)

Pet Type Age
Fido Dog 5
Meowser Cat 8
Oinker Pig 3
Lenny Hamster 1
Meep Mouse 3

Markdown

Pet|Type|Age
---|---|---
Fido|Dog|5
Meowser|Cat|8
Oinker|Pig|3
Lenny|Hamster|1
Meep|Mouse|3

Comments

Sign in to comment.
raccoon   -  Jan 10, 2015

Why don't newlines get a < br > attached?

Hawkee  -  Jan 15, 2015

@raccoon They should, where are you seeing this? It shouldn't accept more than a single newline.

Sign in to comment

Are you sure you want to unfollow this person?
Are you sure you want to delete this?
Click "Unsubscribe" to stop receiving notices pertaining to this post.
Click "Subscribe" to resume notices pertaining to this post.