| Markdown | 21 |HTML | 22 |Rendered Output | 23 |
|---|---|---|
Italicized text is the *cat's meow*. |
28 | Italicized text is the <em>cat's meow</em>. |
29 | Italicized text is the cat’s meow. | 30 |
Italicized text is the _cat's meow_. |
33 | Italicized text is the <em>cat's meow</em>. |
34 | Italicized text is the cat’s meow. | 35 |
A*cat*meow |
38 | A<em>cat</em>meow |
39 | Acatmeow | 40 |
| ✅ Do this | 52 |❌ Don't do this | 53 |
|---|---|
58 |
59 | A*cat*meow
60 |
61 | |
62 |
63 |
64 | A_cat_meow
65 |
66 | |
67 |
I really like using Markdown.
I think I'll use it to format all of my documents from now on.
" 11 | --- 12 | 13 | To create paragraphs, use a blank line to separate one or more lines of text. 14 | 15 || Markdown | 19 |HTML | 20 |Rendered Output | 21 |
|---|---|---|
26 |
27 | I really like using Markdown.
31 | |
32 |
33 | <p>I really like using Markdown.</p>
36 | |
37 |
38 | I really like using Markdown. 39 | 40 |I think I'll use it to format all of my documents from now on. 41 | |
42 |
51 | Note: If you need to indent paragraphs in the output, see the section on how to indent (tab).
52 |
53 |
54 | | ✅ Do this | 58 |❌ Don't do this | 59 |
|---|---|
64 |
65 | Don't put tabs or spaces in front of your paragraphs.
69 | |
70 |
71 |
72 | This can result in unexpected
73 | formatting problems.
77 | |
78 |
-
24 |
- First Term 25 |
- This is the definition of the first term. 26 |
- Second Term 27 |
- This is one definition of the second term. 28 |
- This is another definition of the second term. 29 |
13 | Tip: If you're using a static site generator, make sure you encode HTML pages as UTF-8.
14 |
15 |
16 | ### Using Emoji Shortcodes
17 |
18 | Some Markdown applications allow you to insert emoji by typing emoji shortcodes. These begin and end with a colon and include the name of an emoji.
19 |
20 | ```text
21 | Gone camping! :tent: Be back soon.
22 |
23 | That is so funny! :joy:
24 | ```
25 |
26 | The rendered output looks like this:
27 |
28 | Gone camping! ⛺ Be back soon.
29 |
30 | That is so funny! 😂
31 |
32 |
33 | Note: You can use this list of emoji shortcodes, but keep in mind that emoji shortcodes vary from application to application. Refer to your Markdown application's documentation for more information.
34 |
35 |
--------------------------------------------------------------------------------
/_extended-syntax/fenced-code-blocks.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Fenced Code Blocks
3 | syntax-id: fenced-code-blocks
4 | syntax-summary: |
5 | ```
6 | {
7 | "firstName": "John",
8 | "lastName": "Smith",
9 | "age": 25
10 | }
11 | ```
12 | ---
13 |
14 | The basic Markdown syntax allows you to create [code blocks](/basic-syntax/#code-blocks) by indenting lines by four spaces or one tab. If you find that inconvenient, try using fenced code blocks. Depending on your Markdown processor or editor, you'll use three backticks (```) or three tildes (`~~~`) on the lines before and after the code block. The best part? You don't have to indent any lines!
15 |
16 | ~~~~~~~~~
17 | ```
18 | {
19 | "firstName": "John",
20 | "lastName": "Smith",
21 | "age": 25
22 | }
23 | ```
24 | ~~~~~~~~~
25 |
26 | The rendered output looks like this:
27 |
28 | ```text
29 | {
30 | "firstName": "John",
31 | "lastName": "Smith",
32 | "age": 25
33 | }
34 | ```
35 |
36 |
37 | Tip: Need to display backticks inside a code block? See this section to learn how to escape them.
38 |
39 |
40 | ### Syntax Highlighting
41 |
42 | Many Markdown processors support syntax highlighting for fenced code blocks. This feature allows you to add color highlighting for whatever language your code was written in. To add syntax highlighting, specify a language next to the backticks before the fenced code block.
43 |
44 | ~~~~~~~~~
45 | ```json
46 | {
47 | "firstName": "John",
48 | "lastName": "Smith",
49 | "age": 25
50 | }
51 | ```
52 | ~~~~~~~~~
53 |
54 | The rendered output looks like this:
55 |
56 | ```json
57 | {
58 | "firstName": "John",
59 | "lastName": "Smith",
60 | "age": 25
61 | }
62 | ```
63 |
--------------------------------------------------------------------------------
/_extended-syntax/footnotes.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Footnotes
3 | syntax-id: footnotes
4 | syntax-summary: |
5 | Here's a sentence with a footnote. [^1]
6 |
7 | [^1]: This is the footnote.
8 | ---
9 |
10 | Footnotes allow you to add notes and references without cluttering the body of the document. When you create a footnote, a superscript number with a link appears where you added the footnote reference. Readers can click the link to jump to the content of the footnote at the bottom of the page.
11 |
12 | To create a footnote reference, add a caret and an identifier inside brackets (`[^1]`). Identifiers can be numbers or words, but they can't contain spaces or tabs. Identifiers only correlate the footnote reference with the footnote itself — in the output, footnotes are numbered sequentially.
13 |
14 | Add the footnote using another caret and number inside brackets with a colon and text (`[^1]: My footnote.`). You don't have to put footnotes at the end of the document. You can put them anywhere except inside other elements like lists, block quotes, and tables.
15 |
16 | ```
17 | Here's a simple footnote,[^1] and here's a longer one.[^bignote]
18 |
19 | [^1]: This is the first footnote.
20 |
21 | [^bignote]: Here's one with multiple paragraphs and code.
22 |
23 | Indent paragraphs to include them in the footnote.
24 |
25 | `{ my code }`
26 |
27 | Add as many paragraphs as you like.
28 | ```
29 |
30 | The rendered output looks like this:
31 |
32 | Here's a simple footnote,[^1] and here's a longer one.[^bignote]
33 |
34 | [^1]: This is the first footnote.
35 |
36 | [^bignote]: Here's one with multiple paragraphs and code.
37 |
38 | Indent paragraphs to include them in the footnote.
39 |
40 | `{ my code }`
41 |
42 | Add as many paragraphs as you like.
43 |
--------------------------------------------------------------------------------
/_extended-syntax/heading-ids.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Heading IDs
3 | syntax-id: heading-ids
4 | syntax-summary: "### My Great Heading {#custom-id}"
5 | ---
6 |
7 | Many Markdown processors support custom IDs for [headings](/basic-syntax/#headings) — some Markdown processors automatically add them. Adding custom IDs allows you to link directly to headings and modify them with CSS. To add a custom heading ID, enclose the custom ID in curly braces on the same line as the heading.
8 |
9 | ```text
10 | ### My Great Heading {#custom-id}
11 | ```
12 |
13 | The HTML looks like this:
14 |
15 | ```html
16 | My Great Heading
17 | ``` 18 | 19 | ### Linking to Heading IDs 20 | 21 | You can link to headings with custom IDs in the file by creating a [standard link](/basic-syntax/#links) with a number sign (`#`) followed by the custom heading ID. These are commonly referred to as *anchor links*. 22 | 23 || Markdown | 27 |HTML | 28 |Rendered Output | 29 |
|---|---|---|
[Heading IDs](#heading-ids) |
34 | <a href="#heading-ids">Heading IDs</a> |
35 | Heading IDs | 36 |
17 | Tip: Be sure to test this in your Markdown application before using it. Some Markdown applications use one tilde symbol before and after words not for subscript, but for strikethrough.
18 |
19 |
20 | Alternatively, if your Markdown application supports [HTML](/basic-syntax/#html), you can use the `sub` HTML tag.
21 |
22 | ```html
23 | H2O
24 | ```
--------------------------------------------------------------------------------
/_extended-syntax/superscript.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Superscript
3 | syntax-id: superscript
4 | ---
5 |
6 | This isn't common, but some Markdown processors allow you to use *superscript* to position one or more characters slightly above the normal line of type. To create a superscript, use one caret symbol (`^`) before and after the characters.
7 |
8 | ```text
9 | X^2^
10 | ```
11 |
12 | The rendered output looks like this:
13 |
14 | X2
15 |
16 | Alternatively, if your Markdown application supports [HTML](/basic-syntax/#html), you can use the `sup` HTML tag.
17 |
18 | ```html
19 | X2
20 | ```
--------------------------------------------------------------------------------
/_extended-syntax/task-lists.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Task Lists
3 | syntax-id: task-lists
4 | syntax-summary: |
5 | - [x] Write the press release
6 | - [ ] Update the website
7 | - [ ] Contact the media
8 | ---
9 |
10 | Task lists (also referred to as *checklists* and *todo* lists) allow you to create a list of items with checkboxes. In Markdown applications that support task lists, checkboxes will be displayed next to the content. To create a task list, add dashes (`-`) and brackets with a space (`[ ]`) in front of task list items. To select a checkbox, add an `x` in between the brackets (`[x]`).
11 |
12 | ```
13 | - [x] Write the press release
14 | - [ ] Update the website
15 | - [ ] Contact the media
16 | ```
17 |
18 | The rendered output looks like this:
19 |
20 | 
21 |
--------------------------------------------------------------------------------
/_getting-started/additional-resources.md:
--------------------------------------------------------------------------------
1 | ## Additional Resources
2 |
3 | There are lots of resources you can use to learn Markdown. Here are some other introductory resources:
4 |
5 | - [John Gruber's Markdown documentation](https://daringfireball.net/projects/markdown/). The original guide written by the creator of Markdown.
6 | - [Markdown Tutorial](https://www.markdowntutorial.com/). An open source website that allows you to try Markdown in your web browser.
7 | - [Awesome Markdown](https://github.com/mundimark/awesome-markdown). A list of Markdown tools and learning resources.
8 | - [Typesetting Markdown](https://dave.autonoma.ca/blog/2019/05/22/typesetting-markdown-part-1). A multi-part series that describes an ecosystem for typesetting Markdown documents using [pandoc](https://pandoc.org/) and [ConTeXt](https://www.contextgarden.net/).
9 |
--------------------------------------------------------------------------------
/_getting-started/flavors-of-markdown.md:
--------------------------------------------------------------------------------
1 | ## Flavors of Markdown
2 |
3 | One of the most confusing aspects of using Markdown is that practically every Markdown application implements a slightly different version of Markdown. These variants of Markdown are commonly referred to as *flavors*. It's your job to master whatever flavor of Markdown your application has implemented.
4 |
5 | To wrap your head around the concept of Markdown flavors, it might help to think of them as language dialects. People in New York City speak English just like the people in London, but there are substantial differences between the dialects used in both cities. The same is true for people using different Markdown applications. Using [Dillinger](/tools/dillinger/) to write with Markdown is a vastly different experience than using [Ulysses](/tools/ulysses/).
6 |
7 | Practically speaking, this means you never know exactly what a company means when they say they support "Markdown." Are they talking about only the [basic syntax elements](/basic-syntax/), or all of the basic and [extended syntax elements](/extended-syntax/) combined, or some arbitrary combination of syntax elements? You won't know until you read the documentation or start using the application.
8 |
9 | If you're just starting out, the best advice I can give you is to pick a Markdown application with good Markdown support. That'll go a long way towards maintaining the portability of your Markdown files. You might want to store and use your Markdown files in other applications, and to do that you need to start with an application that provides good support. You can use the [tool directory](/tools/) to find an application that fits the bill.
10 |
--------------------------------------------------------------------------------
/_getting-started/how-does-it-work.md:
--------------------------------------------------------------------------------
1 | ## How Does it Work?
2 |
3 | Dillinger makes writing in Markdown easy because it hides the stuff happening behind the scenes, but it's worth exploring how the process works in general.
4 |
5 | When you write in Markdown, the text is stored in a plaintext file that has an `.md` or `.markdown` extension. But then what? How is your Markdown-formatted file converted into HTML or a print-ready document?
6 |
7 | The short answer is that you need a *Markdown application* capable of processing the Markdown file. There are lots of applications available — everything from simple scripts to desktop applications that look like Microsoft Word. Despite their visual differences, all of the applications do the same thing. Like Dillinger, they all convert Markdown-formatted text to HTML so it can be displayed in web browsers.
8 |
9 | Markdown applications use something called a *Markdown processor* (also commonly referred to as a "parser" or an "implementation") to take the Markdown-formatted text and output it to HTML format. At that point, your document can be viewed in a web browser or combined with a style sheet and printed. You can see a visual representation of this process below.
10 |
11 |
12 | Note: The Markdown application and processor are two separate components. For the sake of brevity, I've combined them into one element ("Markdown app") in the figure below.
13 |
14 |
15 | {% include image.html file="/assets/images/markdown-flowchart.png" alt="The Markdown Process" lazy="yes" %}
16 |
17 | To summarize, this is a four-part process:
18 |
19 | 1. Create a Markdown file using a text editor or a dedicated Markdown application. The file should have an `.md` or `.markdown` extension.
20 | 2. Open the Markdown file in a Markdown application.
21 | 3. Use the Markdown application to convert the Markdown file to an HTML document.
22 | 4. View the HTML file in a web browser or use the Markdown application to convert it to another file format, like PDF.
23 |
24 | From your perspective, the process will vary somewhat depending on the application you use. For example, Dillinger essentially combines steps 1-3 into a single, seamless interface — all you have to do is type in the left pane and the rendered output magically appears in the right pane. But if you use other tools, like a text editor with a static website generator, you'll find that the process is much more visible.
25 |
--------------------------------------------------------------------------------
/_getting-started/kicking-the-tires.md:
--------------------------------------------------------------------------------
1 | ## Kicking the Tires
2 |
3 | The best way to get started with Markdown is to use it. That's easier than ever before thanks to a variety of free tools.
4 |
5 | You don't even need to download anything. There are several online Markdown editors that you can use to try writing in Markdown. [Dillinger](https://dillinger.io/) is one of the best online Markdown editors. Just open the site and start typing in the left pane. A preview of the rendered document appears in the right pane.
6 |
7 | {% include image.html file="/assets/images/dillinger.png" alt="Dillinger Markdown editor" lazy="yes" %}
8 |
9 | You'll probably want to keep the Dillinger website open as you read through this guide. That way you can try the syntax as you learn about it. After you've become familiar with Markdown, you may want to use a Markdown application that can be installed on your desktop computer or mobile device.
10 |
--------------------------------------------------------------------------------
/_getting-started/what-is-markdown.md:
--------------------------------------------------------------------------------
1 | ## What is Markdown?
2 |
3 | Markdown is a lightweight markup language that you can use to add formatting elements to plaintext text documents. Created by [John Gruber](https://daringfireball.net/projects/markdown/) in 2004, Markdown is now one of the world's most popular markup languages.
4 |
5 | Using Markdown is different than using a [WYSIWYG](https://en.wikipedia.org/wiki/WYSIWYG) editor. In an application like Microsoft Word, you click buttons to format words and phrases, and the changes are visible immediately. Markdown isn't like that. When you create a Markdown-formatted file, you add Markdown syntax to the text to indicate which words and phrases should look different.
6 |
7 | For example, to denote a heading, you add a number sign before it (e.g., `# Heading One`). Or to make a phrase bold, you add two asterisks before and after it (e.g., `**this text is bold**`). It may take a while to get used to seeing Markdown syntax in your text, especially if you're accustomed to WYSIWYG applications. The screenshot below shows a Markdown file displayed in the [Visual Studio Code text editor](/tools/vscode/).
8 |
9 | {% include image.html file="/assets/images/vscode.png" alt="Markdown file in the Visual Studio Code text editor" %}
10 |
11 | You can add Markdown formatting elements to a plaintext file using a text editor application. Or you can use one of the many Markdown applications for macOS, Windows, Linux, iOS, and Android operating systems. There are also several web-based applications specifically designed for writing in Markdown.
12 |
13 | Depending on the application you use, you may not be able to preview the formatted document in real time. But that's okay. [According to Gruber](https://daringfireball.net/projects/markdown/), Markdown syntax is designed to be readable and unobtrusive, so the text in Markdown files can be read even if it isn't rendered.
14 |
15 | > The overriding design goal for Markdown’s formatting syntax is to make it as readable as possible. The idea is that 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.
16 |
--------------------------------------------------------------------------------
/_getting-started/why-use-markdown.md:
--------------------------------------------------------------------------------
1 | ## Why Use Markdown?
2 |
3 | You might be wondering why people use Markdown instead of a WYSIWYG editor. Why write with Markdown when you can press buttons in an interface to format your text? As it turns out, there are several reasons why people use Markdown instead of WYSIWYG editors.
4 |
5 | - Markdown can be used for everything. People use it to create [websites](#websites), [documents](#documents), [notes](#notes), [books](#books), [presentations](#presentations), [email messages](#email), and [technical documentation](#documentation).
6 |
7 | - Markdown is portable. Files containing Markdown-formatted text can be opened using virtually any application. If you decide you don't like the Markdown application you're currently using, you can import your Markdown files into another Markdown application. That's in stark contrast to word processing applications like Microsoft Word that lock your content into a proprietary file format.
8 |
9 | - Markdown is platform independent. You can create Markdown-formatted text on any device running any operating system.
10 |
11 | - Markdown is future proof. Even if the application you're using stops working at some point in the future, you'll still be able to read your Markdown-formatted text using a text editing application. This is an important consideration when it comes to books, university theses, and other milestone documents that need to be preserved indefinitely.
12 |
13 | - Markdown is everywhere. Websites like [Reddit](/tools/reddit/) and GitHub support Markdown, and lots of desktop and web-based applications support it.
14 |
--------------------------------------------------------------------------------
/_includes/footer.html:
--------------------------------------------------------------------------------
1 |
7 |
8 |
14 |
15 |
16 |
17 |
27 |
--------------------------------------------------------------------------------
/_includes/image.html:
--------------------------------------------------------------------------------
1 | {% if site.url == "https://www.markdownguide.org" and jekyll.environment == "production" %}
2 | 
5 | {% else %}
6 |
2 |
17 |
18 |
3 |
8 |
16 |
9 |
15 |
10 |
14 | Take your Markdown skills to the next level.
11 |Learn Markdown in 60 pages. Designed for both novices and experts, The Markdown Guide book is a comprehensive reference that has everything you need to get started and master Markdown syntax.
12 | Get the Book 13 |
19 |
--------------------------------------------------------------------------------
/_includes/nav.html:
--------------------------------------------------------------------------------
1 |
26 |
--------------------------------------------------------------------------------
/_includes/see-also.html:
--------------------------------------------------------------------------------
1 | {% if page.see-also %}
2 |
3 | Want to learn more Markdown?
20 |
21 |
34 | 22 | Don't stop now! 🚀 Star the GitHub repository and then enter your email address below to receive new Markdown tutorials via email. No spam!
23 | 24 | 32 | 33 |See Also
4 | 5 |-
6 | {% for link in page.see-also %}
7 |
- {{link.name}} 8 | {% endfor %} 9 |
{{ syntax.title }}
10 | {% elsif include.type == "basic-sub" %} 11 | ### {{ syntax.title }} 12 | {% endif %} 13 | {{ syntax.content }} 14 | {% endfor %} 15 | -------------------------------------------------------------------------------- /_includes/tool-syntax-table.html: -------------------------------------------------------------------------------- 1 | ### {{ page.title }} Markdown Support 2 | 3 | {{ page.title }} provides support for the following Markdown elements. 4 | 5 || Element | 9 |Support | 10 |Notes | 11 |
|---|---|---|
| {{ element.name }} | 19 |{{ status.name }} | 20 |{% if item.notes %}{{ item.notes | markdownify | remove: ' ' | remove: ' ' }}{% endif %} |
21 |
8 |
13 |
9 |
12 | {{ page.title }}
10 |{{ page.description }}
11 |
14 |
28 | {% include footer.html %}
29 |
30 |
31 |
--------------------------------------------------------------------------------
/_layouts/book.html:
--------------------------------------------------------------------------------
1 |
2 |
3 | {% include head.html %}
4 |
5 | {% include nav.html %}
6 |
7 |
15 |
27 |
16 | {{ content }}
17 |
18 |
26 |
8 | {{ content }}
9 |
10 | {% include footer.html %}
11 |
12 |
13 |
--------------------------------------------------------------------------------
/_layouts/default.html:
--------------------------------------------------------------------------------
1 |
2 |
3 | {% include head.html %}
4 |
5 | {% include nav.html %}
6 |
7 |
8 |
13 |
9 |
12 | {{ page.title }}
10 |{{ page.description }}
11 |
14 |
29 | {% include footer.html %}
30 |
31 |
32 |
--------------------------------------------------------------------------------
/_layouts/tool.html:
--------------------------------------------------------------------------------
1 |
2 |
3 | {% include head.html %}
4 | {% include nav.html %}
5 |
15 |
28 |
16 | {{ content }}
17 | {% include mailing-list.html %}
18 |
19 |
20 |
21 | {% if jekyll.environment == "production" %}
22 |
27 |
23 |
24 |
25 | {% endif %}
26 |
6 |
24 | {% include footer.html %}
25 |
26 |
7 |
15 |
16 |
23 | 
9 |
17 | {{ content }}
18 | {% include see-also.html %}
19 | {% include mailing-list.html %}
20 |
21 |
22 |