Table of Contents
Markdown is a simple, lightweight markup language used for formatting plain text. It’s designed to be easy to read and write, and it can be converted into HTML, PDF, LaTEX and many other formats.
It’s a very popular format for writing documentation, blog posts, and notes. It is extremely future-proof since you write documents in plain-text, with some sprinkles of markup.
The key idea is to use simple punctuation to add formatting.
You don’t need to memorize all of these. Just remember the basics and refer back to this guide as needed. The best way to learn Markdown is to start writing!
Common Formatting #
Headers #
Headers are used for titles and subtitles. They are created with the hash symbol (#). The number of hashes determines the size of the header.
# This is a large title (H1) ## This is a major heading (H2) ### This is a sub-heading (H3) #### This is a smaller heading (H4)
Emphasis (Bold and Italic) #
You can make text bold or italic to add emphasis.
This is **bold text** using two asterisks. This is also __bold text__ using two underscores. This is *italic text* using a single asterisk. This is also _italic text_ using a single underscore.
Lists #
Lists are great for organizing information.
Unordered Lists (bullet points) #
Use a hyphen (-) followed by a space.
- First item in the list - Second item in the list - A nested item - Third item
Ordered Lists (numbered) #
Use a number followed by a period and a space.
1. First step 2. Second step 3. Third step 1. A nested step 4. Final step
Links and Images #
Links #
To link to another webpage, use the format: [text to display](URL).
Visit the official [Markdown website](https://daringfireball.net/projects/markdown/).
Images #
Images are similar to links, but they start with an exclamation mark (!).
Other Useful Elements #
Blockquotes #
To quote text from another source, use the `>` symbol.
> "The simplest way to write in Markdown is to just start typing." > > This can span multiple lines.
Horizontal Rule #
A horizontal rule is a line that separates content. Use three or more hyphens (------).
Code Blocks #
To show code or text that should not be formatted, use three backticks (```) before and after the text.
``` This text is inside a code block. It will not be formatted with bold or italic. ```
On editors #
Technical users will be at ease with Markdown, and can edit it and preview it from their favorite editor (think Emacs, Vim, VSCode, IntelliJ, etc.)
For non-technical users, the best Markdown editors are those that prioritize a clean, simple, and intuitive user interface.
The “What You See Is What You Get” (WYSIWYG) Approach: I recommend MarkText (desktop app), A free and open-source alternative to Typora, offering a real-time preview experience. It’s known for its sleek design and focus on a clean, elegant interface.
The “Two-Pane” or “Live Preview” Approach: Ghostwriter (desktop app), Dillinger (web based), StackEdit (web based).
The “Note-Taking” Approach: Obisidan (desktop app), Joplin (desktop app)