DEV Community

loading...

Markdown cheat sheet

Chrissie
Frontend web developer - Software Engineering student
ãƒģ1 min read

Markdown is a markup language that is used to add formatting elements to plain text. It is easy to learn and use. In my opinion, markdown is a must, not only if you want to start posting here on Dev but also for writing readmes. I'm sure by now you've noticed that readme files have the .md extension, that is the markdown file extension and while you can write a readme in plaintext, to make our readme more appealing and comprehensive you should definitely use markdown.

Here's a list of basic Markdown syntax to get you started:

Heading

# Heading 1
## Heading 2
### Heading 3
#### Heading 4
Enter fullscreen mode Exit fullscreen mode

Heading 1

Heading 2

Heading 3

Heading 4

Bold and Italic

**Bold** *Italic*
or
__Bold__ _Italic_
Enter fullscreen mode Exit fullscreen mode

Bold Italic

Bold Italic

Link

[Example](https://example.com)
Enter fullscreen mode Exit fullscreen mode

Example

Blockquote

> Lorem Ipsum
Enter fullscreen mode Exit fullscreen mode

Lorem Ipsum

Image

![alt text](image.jpg)

Enter fullscreen mode Exit fullscreen mode

alt text

List

1. One
2. Two
3. Three 

- List
- List
- List
Enter fullscreen mode Exit fullscreen mode
  1. One
  2. Two
  3. Three
  • List
  • List
  • List

Code

`Inline` code
{```

} 
    code
{

```}
Enter fullscreen mode Exit fullscreen mode

Inline code

console.log(a)

Without the curly braces
Enter fullscreen mode Exit fullscreen mode

For syntax highlighting

{```

} javascript 
    console.log(a)
{

```}
Enter fullscreen mode Exit fullscreen mode
console.log(a)

Without the curly braces
Enter fullscreen mode Exit fullscreen mode

Horizontal Rule

Lorem Ispum 

---

Enter fullscreen mode Exit fullscreen mode

Lorem Ispum


Remember to put a blank line before and after the dashes, without those, the text will appear as a heading.


A lot of markdown applications accept the use of HTML tags so if you are more comfortable using HTML tags over markdown syntax you can use them provided that they are supported by the application.

Discussion (3)

Collapse
andrewbaisden profile image
Andrew Baisden

Thanks for sharing good resource.

Collapse
mazonthemoon profile image
Mary Ronan

Thanks for taking the time to do this Chrissie - I will definitely be putting this to good use! 👍

Collapse
chrissiemhrk profile image
Chrissie Author

You're welcome 🙂