Skip to main content

Markdown Introduction

What is Markdown?

Markdown is a lightweight markup language with plain-text formatting syntax designed for easy readability and writing. It allows you to format text using simple symbols and conventions, such as asterisks or underscores for emphasis, hash symbols for headings, and brackets for links. Markdown is commonly used for formatting text in various contexts, including writing documentation, creating web content, and writing messages on platforms like GitHub, Reddit, and Stack Overflow. Markdown's popularity can be contributed to its:

  • Simplicity: Markdown offers a simple and intuitive syntax that is easy to learn and use. It allows you to format text quickly without needing to memorize complex HTML tags.
  • Versatility: Markdown is widely supported across different platforms and applications, including text editors, blogging platforms, collaboration tools, and version control systems like Git and GitHub. Once you learn Markdown, you can use it in various contexts.
  • Efficiency: Markdown allows you to focus on writing content without getting distracted by formatting options. Its lightweight syntax enables you to format text efficiently, saving time and effort.
  • Collaboration: Many online communities and collaborative platforms use Markdown for formatting text. By learning Markdown, you can effectively communicate and collaborate with others in these environments.
  • Documentation: Markdown is commonly used for writing documentation, readme files, and technical guides. Knowing Markdown can help you create clear and well-organized documentation for your projects.

Learning Markdown can enhance your productivity, improve your communication skills, and makes you more effective in various professional and creative endeavors.

Markdown Basic Syntax

ElementMarkdown Syntax
Heading# H1
## H2
### H3
Bold**bold text**
Italic_italicized text_
Blockquote> blockquote
Ordered List1. First item
2. Second item
3. Third item
Unordered List- First item
- Second item
- Third item
Codecode
Horizontal Rule---
Link[title](https://www.example.com)
Image![alt text](image.jpg)

Markdown Extended Syntax

ElementMarkdown Syntax
Table
Fenced Code Block```
{
"firstName": "John",
"lastName": "Smith",
"age": 25
}
```
FootnoteHere's a sentence with a footnote. [^1]
[^1]: This is the footnote.
Heading ID### My Great Heading {#custom-id}
Definition Listterm
: definition
Strikethrough~~The world is flat.~~
Task List- [x] Write the press release
- [ ] Update the website
- [ ] Contact the media
EmojiThat is so funny! :joy:
HighlightI need to highlight these ==very important words==.
SubscriptH~2~O
SuperscriptX^2^

Sources

  1. Markdown Cheat Sheet