{"componentChunkName":"component---src-templates-post-js","path":"/blog/markdown-examples","webpackCompilationHash":"1ba5a575cf0ff20ad142","result":{"data":{"markdownRemark":{"frontmatter":{"title":"Markdown Examples","description":"Markdown is intended to be as easy-to-read and easy-to-write as is feasible.","image":"/assets/img/03.jpg"},"html":"

Markdown is intended to be as easy-to-read and easy-to-write as is feasible.

\n

Readability, however, is emphasized above all else. A Markdown-formatted document should be publishable as-is, as plain text, without looking like it’s been marked up with tags or formatting instructions. While Markdown’s syntax has been influenced by several existing text-to-HTML filters — including Setext, atx, Textile, reStructuredText, Grutatext, and EtText — the single biggest source of inspiration for Markdown’s syntax is the format of plain text email.

\n

To this end, Markdown’s syntax is comprised entirely of punctuation characters, which punctuation characters have been carefully chosen so as to look like what they mean. E.g., asterisks around a word actually look like emphasis. Markdown lists look like, well, lists. Even blockquotes look like quoted passages of text, assuming you’ve ever used email.

\n

Headers

\n
# H1\n## H2\n### H3\n#### H4\n##### H5\n###### H6\n\nAlternatively, for H1 and H2, an underline-ish style:\n\nAlt-H1\n======\n\nAlt-H2\n------
\n

H1

\n

H2

\n

H3

\n

H4

\n
H5
\n
H6
\n

Lists

\n
1. First ordered list item\n2. Another item\n⋅⋅* Unordered sub-list.\n1. Actual numbers don't matter, just that it's a number\n⋅⋅1. Ordered sub-list\n4. And another item.\n\n⋅⋅⋅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).\n\n⋅⋅⋅To have a line break without a paragraph, you will need to use two trailing spaces.⋅⋅\n⋅⋅⋅Note that this line is separate, but within the same paragraph.⋅⋅\n⋅⋅⋅(This is contrary to the typical GFM line break behaviour, where trailing spaces are not required.)\n\n* Unordered list can use asterisks\n- Or minuses\n+ Or pluses
\n
    \n
  1. First ordered list item
    2. \n
  2. Another item\n⋅⋅* Unordered sub-list.
    3. \n
  3. Actual numbers don't matter, just that it's a number\n⋅⋅1. Ordered sub-list
    4. \n
  4. And another item.
    5. \n
\n

⋅⋅⋅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).

\n

⋅⋅⋅To have a line break without a paragraph, you will need to use two trailing spaces.⋅⋅\n⋅⋅⋅Note that this line is separate, but within the same paragraph.⋅⋅\n⋅⋅⋅(This is contrary to the typical GFM line break behaviour, where trailing spaces are not required.)

\n\n

Links

\n
[I'm an inline-style link](https://www.google.com)\n\n[I'm an inline-style link with title](https://www.google.com \"Google's Homepage\")\n\n[I'm a reference-style link][Arbitrary case-insensitive reference text]\n\n[I'm a relative reference to a repository file](../blob/master/LICENSE)\n\n[You can use numbers for reference-style link definitions][1]\n\nOr leave it empty and use the [link text itself].\n\nURLs and URLs in angle brackets will automatically get turned into links.\nhttp://www.example.com or <http://www.example.com> and sometimes\nexample.com (but not on Github, for example).\n\nSome text to show that the reference links can follow later.\n\n[arbitrary case-insensitive reference text]: https://www.mozilla.org\n[1]: http://slashdot.org\n[link text itself]: http://www.reddit.com
\n

I'm an inline-style link

\n

I'm an inline-style link with title

\n

I'm a reference-style link

\n

I'm a relative reference to a repository file

\n

You can use numbers for reference-style link definitions

\n

Or leave it empty and use the link text itself.

\n

URLs and URLs in angle brackets will automatically get turned into links.\nhttp://www.example.com or http://www.example.com and sometimes\nexample.com (but not on Github, for example).

\n

Some text to show that the reference links can follow later.

\n

Blockquotes

\n
> Blockquotes are very handy in email to emulate reply text.\n> This line is part of the same quote.\n\nQuote break.\n\n> 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.
\n
\n

Blockquotes are very handy in email to emulate reply text.\nThis line is part of the same quote.

\n
\n

Quote break.

\n
\n

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.

\n
\n

Reference 1\nReference 2

"}},"pageContext":{"isCreatedByStatefulCreatePages":false,"locale":"en","title":"Markdown Examples"}}}