Skip to content

Updated cheat-sheet.md and started translation #56

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Updated cheat-sheet.md and started translation #56

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
295 changes: 148 additions & 147 deletions cheat-sheet.md
100644 → 100755
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,147 +1,148 @@
---
layout: default
title: Markdown Cheat Sheet
description: A quick reference to the Markdown syntax.
last_modified_at: 2020-07-31
---

## Overview

This Markdown cheat sheet provides a quick overview of all the Markdown syntax elements. It can't cover every edge case, so if you need more information about any of these elements, refer to the reference guides for [basic syntax](/basic-syntax) and [extended syntax](/extended-syntax).

## Basic Syntax

These are the elements outlined in John Gruber's original design document. All Markdown applications support these elements.

<table class="table table-bordered">
<thead class="thead-light">
<tr>
<th>Element</th>
<th>Markdown Syntax</th>
</tr>
</thead>
<tbody>
<tr>
<td><a href="/basic-syntax/#headings">Heading</a></td>
<td><code># H1<br>
## H2<br>
### H3</code></td>
</tr>
<tr>
<td><a href="/basic-syntax/#bold">Bold</a></td>
<td><code>**bold text**</code></td>
</tr>
<tr>
<td><a href="/basic-syntax/#italic">Italic</a></td>
<td><code>*italicized text*</code></td>
</tr>
<tr>
<td><a href="/basic-syntax/#blockquotes-1">Blockquote</a></td>
<td><code>> blockquote</code></td>
</tr>
<tr>
<td><a href="/basic-syntax/#ordered-lists">Ordered List</a></td>
<td><code>
1. First item<br>
2. Second item<br>
3. Third item<br>
</code></td>
</tr>
<tr>
<td><a href="/basic-syntax/#unordered-lists">Unordered List</a></td>
<td>
<code>
- First item<br>
- Second item<br>
- Third item<br>
</code>
</td>
</tr>
<tr>
<td><a href="/basic-syntax/#code">Code</a></td>
<td><code>`code`</code></td>
</tr>
<tr>
<td><a href="/basic-syntax/#horizontal-rules">Horizontal Rule</a></td>
<td><code>---</code></td>
</tr>
<tr>
<td><a href="/basic-syntax/#links">Link</a></td>
<td><code>[title](https://www.example.com)</code></td>
</tr>
<tr>
<td><a href="/basic-syntax/#images-1">Image</a></td>
<td><code>![alt text](image.jpg)</code></td>
</tr>
</tbody>
</table>

## Extended Syntax

These elements extend the basic syntax by adding additional features. Not all Markdown applications support these elements.

<table class="table table-bordered">
<thead class="thead-light">
<tr>
<th>Element</th>
<th>Markdown Syntax</th>
</tr>
</thead>
<tbody>
<tr>
<td><a href="/extended-syntax/#tables">Table</a></td>
<td><code>
| Syntax | Description |<br>
| ----------- | ----------- |<br>
| Header | Title |<br>
| Paragraph | Text |
</code></td>
</tr>
<tr>
<td><a href="/extended-syntax/#fenced-code-blocks">Fenced Code Block</a></td>
<td><code>```<br>
{<br>
&nbsp;&nbsp;"firstName": "John",<br>
&nbsp;&nbsp;"lastName": "Smith",<br>
&nbsp;&nbsp;"age": 25<br>
}<br>
```
</code></td>
</tr>
<tr>
<td><a href="/extended-syntax/#footnotes">Footnote</a></td>
<td><code>
Here's a sentence with a footnote. [^1]<br><br>

[^1]: This is the footnote.
</code></td>
</tr>
<tr>
<td><a href="/extended-syntax/#heading-ids">Heading ID</a></td>
<td><code>### My Great Heading {#custom-id}</code></td>
</tr>
<tr>
<td><a href="/extended-syntax/#definition-lists">Definition List</a></td>
<td><code>
term<br>
: definition
</code></td>
</tr>
<tr>
<td><a href="/extended-syntax/#strikethrough">Strikethrough</a></td>
<td><code>~~The world is flat.~~</code></td>
</tr>
<tr>
<td><a href="/extended-syntax/#task-lists">Task List</a></td>
<td><code>
- [x] Write the press release<br>
- [ ] Update the website<br>
- [ ] Contact the media
</code></td>
</tr>
</tbody>
</table>

## Downloads

You can <a href="/assets/markdown-cheat-sheet.md" download="markdown-cheat-sheet.md">download this cheat sheet as a Markdown file</a> for use in your Markdown application.
---
layout: default
title: Markdown Cheat Sheet
description: A quick reference to the Markdown syntax.
last_modified_at: 2020-10-22
---

## Overview

This Markdown cheat sheet provides a quick overview of all the Markdown syntax elements. It can't cover every edge case, so if you need more information about any of these elements, refer to the reference guides for [basic syntax](/basic-syntax) and [extended syntax](/extended-syntax).

## Basic Syntax

These are the elements outlined in John Gruber's original design document. All Markdown applications support these elements.

<table class="table table-bordered">
<thead class="thead-light">
<tr>
<th>Element</th>
<th>Markdown Syntax</th>
</tr>
</thead>
<tbody>
<tr>
<td><a href="/basic-syntax/#headings">Heading</a></td>
<td><code># H1<br>
## H2<br>
### H3</code></td>
</tr>
<tr>
<td><a href="/basic-syntax/#bold">Bold</a></td>
<td><code>**bold text**</code></td>
</tr>
<tr>
<td><a href="/basic-syntax/#italic">Italic</a></td>
<td><code>*italicized text*</code></td>
</tr>
<tr>
<td><a href="/basic-syntax/#blockquotes-1">Blockquote</a></td>
<td><code>> blockquote</code></td>
</tr>
<tr>
<td><a href="/basic-syntax/#ordered-lists">Ordered List</a></td>
<td><code>
1. First item<br>
2. Second item<br>
3. Third item<br>
</code></td>
</tr>
<tr>
<td><a href="/basic-syntax/#unordered-lists">Unordered List</a></td>
<td>
<code>
- First item<br>
- Second item<br>
- Third item<br>
</code>
</td>
</tr>
<tr>
<td><a href="/basic-syntax/#code">Code</a></td>
<td><code>`code`</code></td>
</tr>
<tr>
<td><a href="/basic-syntax/#horizontal-rules">Horizontal Rule</a></td>
<td><code>---</code></td>
</tr>
<tr>
<td><a href="/basic-syntax/#links">Link</a></td>
<td><code>[title](https://www.example.com)</code></td>
</tr>
<tr>
<td><a href="/basic-syntax/#images-1">Image</a></td>
<td><code>![alt text](image.jpg)</code></td>
</tr>
</tbody>
</table>

## Extended Syntax

These elements extend the basic syntax by adding additional features. Not all Markdown applications support these elements.

<table class="table table-bordered">
<thead class="thead-light">
<tr>
<th>Element</th>
<th>Markdown Syntax</th>
</tr>
</thead>
<tbody>
<tr>
<td><a href="/extended-syntax/#tables">Table</a></td>
<td><code>
| Syntax | Description |<br>
| ----------- | ----------- |<br>
| Header | Title |<br>
| Paragraph | Text |
</code></td>
</tr>
<tr>
<td><a href="/extended-syntax/#fenced-code-blocks">Fenced Code Block</a></td>
<td><code>```<br>
{<br>
&nbsp;&nbsp;"firstName": "John",<br>
&nbsp;&nbsp;"lastName": "Smith",<br>
&nbsp;&nbsp;"age": 25<br>
}<br>
```
</code></td>
</tr>
<tr>
<td><a href="/extended-syntax/#footnotes">Footnote</a></td>
<td><code>
Here's a sentence with a footnote. [^1]<br><br>
``
[^1]: This is the footnote.
``
</code></td>
</tr>
<tr>
<td><a href="/extended-syntax/#heading-ids">Heading ID</a></td>
<td><code>### My Great Heading {#custom-id}</code></td>
</tr>
<tr>
<td><a href="/extended-syntax/#definition-lists">Definition List</a></td>
<td><code>
term<br>
: definition
</code></td>
</tr>
<tr>
<td><a href="/extended-syntax/#strikethrough">Strikethrough</a></td>
<td><code>~~The world is flat.~~</code></td>
</tr>
<tr>
<td><a href="/extended-syntax/#task-lists">Task List</a></td>
<td><code>
- [x] Write the press release<br>
- [ ] Update the website<br>
- [ ] Contact the media
</code></td>
</tr>
</tbody>
</table>

## Downloads

You can <a href="/assets/markdown-cheat-sheet.md" download="markdown-cheat-sheet.md">download this cheat sheet as a Markdown file</a> for use in your Markdown application.
Loading