Skip to content

udanielnogueira/markdown-syntax

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

41 Commits
 
 
 
 

Repository files navigation

Markdown Syntax

Markdown basic syntax.

Heading

To create a heading, add number signs (#) in front of a word or phrase.

# heading 1
## heading 2
## heading 3

Heading best practices

Try to put a blank line before and after a heading.

Paragraphs

Use a blank line to separate one or more lines.

I really like using Markdown.

Paragraphs best practices

Unless the paragraph is in a list, don't put tabs or spaces in front of your paragraphs.

Emphasis

You can add emphasis by making text bold or italic.

Bold

We love **bold text**.
We love **bold text**.

Italic

We love _italic text_.
We love _italic text_.

Bold and italic

We love **_bold and italic text_**.
We love **_bold and italic text_**.

Blockquotes

To create a blockquote, add a > in front of a paragraph.

> Dorothy followed her through many of the beautiful rooms in her castle.

Ordered lists

Add line items with numbers followed by periods, you can indent them too. The numbers don’t have to be in numerical order, but the list should start with the number one.

1. First item
1. Second item
1. Third item

Unordered lists

Add dashes (-), asterisks (*), or plus signs (+) in front of line items. You can indent one or more items too.

- First item

* Second item

- Third item

Code

To denote a word or phrase as code, enclose it in backticks (`).

This is `a bit of code!`

Horizontal rules

Use three or more asterisks (***), dashes (---), or underscores (___).

---
---

---

Links

To create a link, enclose the link text in brackets and then follow it immediately with the URL in parentheses.

My favorite search engine is [Duck Duck Go](https://duckduckgo.com).

Output:

My favorite search engine is Duck Duck Go

Adding titles

You can optionally add a title for a link, this will appear when the user hovers over the link.

My favorite search engine [Duck Duck Go](https://duckduckgo.com "The best search engine for privacy").

Output:

My favorite search engine Duck Duck Go.

URL and email

To quickly turn a URL or email address into a link, enclose it in angle brackets.

<https://www.markdownguide.org>

<fake@example.com>

Output:

https://www.markdownguide.org

fake@example.com

Images

Add an exclamation mark (!), followed by alt text in brackets, and the path or URL to the image asset in parentheses. You can optionally add a title in quotation marks after the path or URL.

![This is an image](guy-coding.gif "This guy is coding")

This is an image

References

https://www.markdownguide.org/basic-syntax

About

Markdown basic syntax.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors