Markdown Guide

What is Markdown?#

Markdown is a lightweight markup language that you can use to add formatting elements to plaintext text documents.

Created by John Gruber in 2004, Markdown is now one of the world’s most popular markup languages. More About Markdown.


Basic Syntax#

ComponentSyntax
Heading# H1
## H2
### H3
Bold**Text** or __text__
Italic*text* or _text_
Blockquote> Blockquote
Ordered List1. First Item
2. Second Item
3. Third Item
Unordered List- First Item
- Second Item
- Third Item
Horizontal Rule---
Link[title](https://www.example.com)
Image![text](image.jpg)
Line Breaktext + double space
Comments<!---Comment--->

Can get up to 6 different headings depending on the number of #


Structure Syntax#

Unordered List#

Syntax
- First Item
- Sub Item
- Second Item
- Third Item

Example:

  • First Item
    • Sub Item
  • Second Item
  • Third Item

More Information.

Ordered List#

Syntax
1. First Item
1. Sub Item
2. Second Item
3. Third Item

Example:

  1. First Item
    1. Sub Item
  2. Second Item
  3. Third Item

More Information.

Table#

Syntax
|Left title | Title center | Right title |
| :---- | :----: | ----: |
| Left | Center | Right |
| Left | Center | Right |

Example:

Left titleTitleRight title
LeftCenterRight
LeftCenterRight

More Information.

Check List#

Syntax
- [x] First option
- [ ] Second option
- [ ] Third option

Example:

  • First option
  • Second option
  • Third option

More Information.

Line Break#

Syntax
Text <!---Space Space--->
another Text

Example:

Text
Another Text

Comments #

Syntax
[comment]: <> (This is a comment, it will not be included)
[//]: <> (This is also a comment.)
[//]: # (This may be the most platform independent comment)`

Another Syntaxes#

Links#

Syntax
[EOS Costa Rica](https://es.eoscostarica.io)

Example:
EOS Costa Rica

Images#

Syntax
![](https://raw.githubusercontent.com/eoscostarica/design-assets/master/logos/eosCR/fullColor-horizontal-transparent-white.png)

Example:

Block Citation#

Syntax
> Main Text
>> Text
>>
> * Item
> * Item
> Text
> Final Text

Example:

Main Text

Text

  • Item
  • Item Texto Final Text

Horizontal Rule#

Syntax
---
***
- - - -

Example:




More Information.


For more information about Markdown Syntax visit this page

Last updated on by JustinCast