AndrewFakher / Markdown-Guide

This Markdown cheat sheet provides a quick overview of most the Markdown syntax elements.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Markdown Guide

Markdown Guide

This Markdown cheat sheet provides a quick overview of most the Markdown syntax elements.

1. Badges

Shields.io Contains quality metadata badges for open source projects.

[![Build Status](https://img.shields.io/travis/markdown-it/markdown-it-deflist/master.svg?style=flat)](https://shields.io)  
[![Coverage Status](https://img.shields.io/coveralls/markdown-it/markdown-it-deflist/master.svg?style=flat)](https://shields.io)

Build Status Coverage Status


2. Check List

- [ ] item 1
- [x] item 2
  • item 1
  • item 2

3. Ordered List

1. First item
2. Second item
3. Third item
  1. First item
  2. Second item
  3. Third item

4. Sub Ordered List

1. First item
2. Second item
3. Third item
    1. Indented item
    2. Indented item
  1. First item
  2. Second item
  3. Third item
    1. Indented item
    2. Indented item

5. Unordered List

- First item
- Second item
- Third item
  • First item
  • Second item
  • Third item

6. Sub Unordered List

- First item
- Second item
- Third item
    - Indented item
    - Indented item
  • First item
  • Second item
  • Third item
    • Indented item
    • Indented item

7. Nested lists

- First item
  - sub-item
    - sub-sub-item
  • First item
    • sub-item
      • sub-sub-item

8. Dropdown Menu

  <details>
	<summary><code>Swift 5.2</code> </summary>

	Released July 15, 2019	<br>
	<a href='https://github.com/AndrewFakher/GitDemo/blob/master/github.png'><code>Screenshot</code></a> 
  </details>

9. Text Format

**bold text**
*italicized text*
~~The world is flat.~~

bold text
italicized text
The world is flat.


10. Definitions

Markdown
: Markdown is a lightweight markup language with plain text formatting syntax. Its design allows it to be converted to many output formats, but the original 
tool by the same name only supports HTML.

Markdown : Markdown is a lightweight markup language with plain text formatting syntax. Its design allows it to be converted to many output formats, but the original tool by the same name only supports HTML.


11. Footnote

<sup>1</sup>This is the first footnote.

1This is the first footnote.


12. New line

You can make a new line by ending a line with two spaces
you don't have to use <br>.


13. Blockquote

> blockquote

blockquote


14. Nested blockquote

> blockquote
>> nested blockquote

blockquote

nested blockquote


15. Keyboard Actions

<kbd>CMD</kbd> + <kbd>R</kbd>

CMD + R


16. Fenced Code Block

    ```json
{
  "firstName": "John",
  "lastName": "Smith",
  "age": 25
}
    ```
{
  "firstName": "John",
  "lastName": "Smith",
  "age": 25
}

17. Link

[Github](https://www.github.com)

Github


18. Back to top

[↑Top of the page↑](#readme) 

↑Top of the page↑


19. Image

![alt text](https://github.com/AndrewFakher/Markdown-Guide/blob/master/github.png)

alt text

19.1 Simple Icons

  • Supports SVG Icons icons for popular brands only.
  • Black color only.
  • HTML syntax.
  • Higher quality.
<img alt="simple-icons" width="80" src="https://cdn.jsdelivr.net/npm/simple-icons@latest/icons/github.svg" />

simple-icons

19.2 Octicons

Octicons Are a set of SVG icons built by GitHub for GitHub.

<img alt="simple-icons" width="80" src="https://github.com/primer/octicons/blob/master/icons/git-merge-16.svg" />

simple-icons


20. Table

| Syntax | Description |
| ----------- | ----------- |
| Header | Title |
| Paragraph | Text |
Syntax Description
Header Title
Paragraph Text

20.1 Table With Alignment

| Left        | Center      | Right         |
| :---        |    :----:   |          ---: |
| Header      | Title       | Here's this   |
| Paragraph   | Text        | And more      |
Left Center Right
Header Title Here's this
Paragraph Text And more

21. Emoji

You can use this list of emoji shortcodes

Gone camping! :tent: Be back soon.
That is so funny! :joy:

Gone camping! ⛺ Be back soon.
That is so funny! 😂


22. Captions

<div align= "center">
    <sub>© 2020, licensed under the <a href="https://opensource.org/licenses/MIT">MIT License</a>.</sub>
</div>
© 2020, licensed under the MIT License.

23. Contributors Image

contributors-img To Keep in sync your contributors list, ENTER repository name and GENERATE an dynamic image URL for displaying it!

<a href="https://github.com/nextcloud/docker/graphs/contributors">
  <img src="https://contributors-img.web.app/image?repo=nextcloud/docker" />
</a>

24. Horizontal Rule

---

You have finally reached the end!

About

This Markdown cheat sheet provides a quick overview of most the Markdown syntax elements.