Alternatively, for H1 and H2, an underline-ish style:
# Alt-H1## Alt-H2
Alt-H1
Alt-H2
Emphasis
Emphasis, aka italics, with _asterisks_ or _underscores_.Strong emphasis, aka bold, with **asterisks** or **underscores**.Combined emphasis with **asterisks and _underscores_**.Strikethrough uses two tildes. ~~Scratch this.~~**This is bold text****This is bold text**_This is italic text__This is italic text_~~Strikethrough~~
Emphasis, aka italics, with asterisks or underscores.Strong emphasis, aka bold, with asterisks or underscores.Combined emphasis with asterisks and underscores.Strikethrough uses two tildes. Scratch this.This is bold textThis is bold textThis is italic textThis is italic textStrikethrough
Lists
1. First ordered list item2. Another item - Unordered sub-list.3. Actual numbers don't matter, just that it's a number4. Ordered sub-list5. And another item.You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we'll use three here to also align the raw Markdown). To have a line break without a paragraph, you will need to use two trailing spaces.⋅⋅ Note that this line is separate, but within the same paragraph. (This is contrary to the typical GFM line break behaviour, where trailing spaces are not required.)- Unordered list can use asterisks* Or minuses- Or pluses1. Make my changes 1. Fix bug 2. Improve formatting - Make the headings bigger2. Push my commits to GitHub3. Open a pull request - Describe my changes - Mention all the members of my team - Ask for feedback- Create a list by starting a line with `+`, `-`, or `*`- Sub-lists are made by indenting 2 spaces: - Marker character change forces new list start: - Ac tristique libero volutpat at * Facilisis in pretium nisl aliquet - Nulla volutpat aliquam velit- Very easy!
First ordered list item
Another item
Unordered sub-list.
Actual numbers don't matter, just that it's a number
Ordered sub-list
And another item.
You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we'll use three here to also align the raw Markdown).To have a line break without a paragraph, you will need to use two trailing spaces.⋅⋅
Note that this line is separate, but within the same paragraph.
(This is contrary to the typical GFM line break behaviour, where trailing spaces are not required.)
Unordered list can use asterisks
Or minuses
Or pluses
Make my changes
Fix bug
Improve formatting
Make the headings bigger
Push my commits to GitHub
Open a pull request
Describe my changes
Mention all the members of my team
Ask for feedback
Create a list by starting a line with +, -, or *
Sub-lists are made by indenting 2 spaces:
Marker character change forces new list start:
Ac tristique libero volutpat at
Facilisis in pretium nisl aliquet
Nulla volutpat aliquam velit
Very easy!
Task lists
- [x] Finish my changes- [ ] Push my commits to GitHub- [ ] Open a pull request- [x] @mentions, #refs, [links](https://hello.com), **formatting**, and <del>tags</del> supported- [x] list syntax required (any unordered or ordered list supported)- [ ] this is a complete item- [ ] this is an incomplete item
Finish my changes
Push my commits to GitHub
Open a pull request
@mentions, #refs, links, formatting, and tags supported
list syntax required (any unordered or ordered list supported)
this is a complete item
this is an incomplete item
Ignoring Markdown formatting
You can tell GitHub to ignore (or escape) Markdown formatting by using \ before the Markdown character.
Let's rename \*our-new-project\* to \*our-old-project\*.
Let's rename *our-new-project* to *our-old-project*.
Links
[I'm an inline-style link](https://www.google.com)[I'm an inline-style link with title](https://www.google.com "Google's Homepage")[I'm a reference-style link][Arbitrary case-insensitive reference text][I'm a relative reference to a repository file](../blob/master/LICENSE)[You can use numbers for reference-style link definitions][1]Or leave it empty and use the [link text itself].URLs and URLs in angle brackets will automatically get turned into links.http://www.example.com and sometimesexample.com (but not on Github, for example).Some text to show that the reference links can follow later.[arbitrary case-insensitive reference text]: https://www.mozilla.org[1]: http://slashdot.org[link text itself]: http://www.reddit.com
Here's our logo (hover to see the title text):Inline-style:Reference-style:![alt text][logo][logo]: https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png "Logo Title Text 2"Like links, Images also have a footnote style syntax![Alt text][id]With a reference later in the document defining the URL location:[id]: https://octodex.github.com/images/dojocat.jpg "The Dojocat"------# [Footnotes](https://github.com/markdown-it/markdown-it-footnote)Footnote 1 link[^first].Footnote 2 link[^second].Inline footnote^[Text of inline footnote] definition.Duplicated footnote reference[^second].[^first]: Footnote **can have markup** and multiple paragraphs.[^second]: Footnote text.
Here's our logo (hover to see the title text):Inline-style:
alt textReference-style:
alt textMinionStormtroopocatLike links, Images also have a footnote style syntaxAlt textWith a reference later in the document defining the URL location:
function $initHighlight(block,cls) { try { if (cls.search(/\bno\-highlight\b/) != -1) return process(block, true,0x0F) + ` class="${cls}"`; } catch (e) { /* handle exception */ } for (var i = 0 / 2; i < classes.length; i++) { if (checkCondition(classes[i]) === undefined) console.log('undefined'); }}export $initHighlight;
Tables
Colons can be used to align columns.| Tables | Are | Cool || ------------- |:-------------:| -----:|| col 3 is | right-aligned | $1600 || col 2 is | centered | $12 || zebra stripes | are neat | $1 |There must be at least 3 dashes separating each header cell.The outer pipes (|) are optional, and you don't need to make theraw Markdown line up prettily. You can also use inline Markdown.Markdown | Less | Pretty--- | --- | ---*Still* | `renders` | **nicely**1 | 2 | 3| First Header | Second Header || ------------- | ------------- || Content Cell | Content Cell || Content Cell | Content Cell || Command | Description || --- | --- || git status | List all new or modified files || git diff | Show file differences that haven't been staged || Command | Description || --- | --- || `git status` | List all *new or modified* files || `git diff` | Show file differences that **haven't been** staged || Left-aligned | Center-aligned | Right-aligned || :--- | :---: | ---: || git status | git status | git status || git diff | git diff | git diff || Name | Character || --- | --- || Backtick | ` || Pipe | \| |
Colons can be used to align columns.
Tables
Are
Cool
col 3 is
right-aligned
$1600
col 2 is
centered
$12
zebra stripes
are neat
$1
There must be at least 3 dashes separating each header cell.
The outer pipes (|) are optional, and you don't need to make the
raw Markdown line up prettily. You can also use inline Markdown.
Markdown
Less
Pretty
Still
renders
nicely
1
2
3
First Header
Second Header
Content Cell
Content Cell
Content Cell
Content Cell
Command
Description
git status
List all new or modified files
git diff
Show file differences that haven't been staged
Command
Description
git status
List all new or modified files
git diff
Show file differences that haven't been staged
Left-aligned
Center-aligned
Right-aligned
git status
git status
git status
git diff
git diff
git diff
Name
Character
Backtick
`
Pipe
|
Blockquotes
> Blockquotes are very handy in email to emulate reply text.> This line is part of the same quote.Quote break.> This is a very long line that will still be quoted properly when it wraps. Oh boy let's keep writing to make sure this is long enough to actually wrap for everyone. Oh, you can *put* **Markdown** into a blockquote.>> <footer>Great Guy Sensei</footer>> Blockquotes can also be nested...>> ...by using additional greater-than signs right next to each other...> > > ...or with spaces between arrows.
Blockquotes are very handy in email to emulate reply text.
This line is part of the same quote.
Quote break.
This is a very long line that will still be quoted properly when it wraps. Oh boy let's keep writing to make sure this is long enough to actually wrap for everyone. Oh, you can putMarkdown into a blockquote.
Blockquotes can also be nested...
...by using additional greater-than signs right next to each other...
...or with spaces between arrows.
Inline HTML
<dl> <dt>Definition list</dt> <dd>Is something people use sometimes.</dd> <dt>Markdown in HTML</dt> <dd>Does *not* work **very** well. Use HTML <em>tags</em>.</dd></dl>
Definition list
Is something people use sometimes.
Markdown in HTML
Does not work very well. Use HTML tags.
Horizontal Rules
Three or more...---Hyphens***Asterisks___Underscores
Three or more...HyphensAsterisksUnderscores
YouTube Videos
[](http://www.youtube.com/watch?v=YOUTUBE_VIDEO_ID_HERE)
Codepen embeds
Footnotes
Footnote can have markupand multiple paragraphs. ↩
With more than a decade into front-end wizardry, I can turn your ideas into pixel-perfect magic, with a side of witty banter and enough positivity to fuel a small city. Let's build something awesome together!