The Markdown Guide
The Markdown Guide
About the Book
You Need to Learn Markdown
I'm a technical writer, and I've used a lot of writing tools over the course of my professional career. One of the most interesting tools I've encountered is Markdown.
I've been using Markdown for years now and I recommend it to everyone I know. There are lots of reasons why you should learn to write using Markdown, but one of the best reasons is that it's better than the alternatives.
Learning Markdown means you can stop using all the subpar writing tools you've tolerated for years. It can also further your career. Believe it or not, knowing how to write using Markdown is a requirement for many jobs.
Markdown is Everywhere
My litmus test for a successful writing tool is whether using it can become second nature. Does writing with it feel natural? Or do I feel like I'm constantly fighting against it? I stop using tools that hinder me. Time is valuable, and I don't have the luxury of indulging things that squander that precious resource.
Markdown passes the test with flying colors. Writing using Markdown just feels right. Since its introduction in 2004, millions of people have starting using it to write everything from notes to documents. It's one of the most successful markup languages of all time.
Markdown has succeeded where other markup languages have failed because it strikes the right balance between power and simplicity. It's easy to learn and simple to use. Its tremendous success means it's ubiquitous enough to replace WYSIWYG editors on websites like Reddit and GitHub. But Markdown is also powerful enough to create documents, books, and technical documentation. Markdown is literally everywhere.
Get Going Fast
So you want to learn to write using Markdown. Great! Now what?
I was in your shoes once, too. I wanted to learn Markdown, but I couldn't find any good resources for beginners. That's why I decided to create the Markdown Guide. It's designed to be a comprehensive reference guide to the Markdown markup language.
Table of Contents
-
Introduction
-
How to Read This Book
- Beginner Resources
- Syntax Examples
- Asides
- Quirks
- Contributing
- Reporting Issues
- Acknowledgements
-
How to Read This Book
-
1. Getting Started
- Why Use Markdown?
- Kicking the Tires
- How Markdown Works
- Flavors of Markdown
- Additional Resources
-
2. Doing Things With Markdown
- Websites
- Documents
- Notes
- Books
- Presentations
- Collaboration
- Documentation
-
3. Basic Syntax
-
Headings
- Alternate Syntax
- Heading Best Practices
-
Paragraphs
- Paragraph Best Practices
-
Line Breaks
- Line Break Best Practices
-
Emphasis
- Bold
- Italic
- Bold and Italic
-
Blockquotes
- Blockquotes with Multiple Paragraphs
- Nested Blockquotes
- Blockquotes with Other Elements
- Blockquotes Best Practices
-
Lists
- Ordered Lists
- Unordered Lists
- Adding Elements in Lists
-
Code
- Escaping Backticks
- Code Blocks
-
Horizontal Rules
- Horizontal Rule Best Practices
-
Links
- Adding Titles
- URLs and Email Addresses
- Formatting Links
- Reference-style Links
- Link Best Practices
-
Images
- Linking Images
-
Escaping Characters
- Characters You Can Escape
-
HTML
- HTML Best Practices
-
Headings
-
4. Extended Syntax
-
Availability
- Lightweight Markup Languages
- Markdown Processors
-
Tables
- Alignment
- Formatting Text in Tables
- Escaping Pipe Characters in Tables
-
Fenced Code Blocks
- Syntax Highlighting
- Footnotes
-
Heading IDs
- Linking to Heading IDs
- Definition Lists
- Strikethrough
- Task Lists
-
Emoji
- Copying and Pasting Emoji
- Using Emoji Shortcodes
-
Automatic URL Linking
- Disabling Automatic URL Linking
-
Availability
-
5. Cheat Sheet
- Basic Syntax
- Extended Syntax
- About the Author
- Notes
The Leanpub 60 Day 100% Happiness Guarantee
Within 60 days of purchase you can get a 100% refund on any Leanpub purchase, in two clicks.
Now, this is technically risky for us, since you'll have the book or course files either way. But we're so confident in our products and services, and in our authors and readers, that we're happy to offer a full money back guarantee for everything we sell.
You can only find out how good something is by trying it, and because of our 100% money back guarantee there's literally no risk to do so!
So, there's no reason not to click the Add to Cart button, is there?
See full terms...
Earn $8 on a $10 Purchase, and $16 on a $20 Purchase
We pay 80% royalties on purchases of $7.99 or more, and 80% royalties minus a 50 cent flat fee on purchases between $0.99 and $7.98. You earn $8 on a $10 sale, and $16 on a $20 sale. So, if we sell 5000 non-refunded copies of your book for $20, you'll earn $80,000.
(Yes, some authors have already earned much more than that on Leanpub.)
In fact, authors have earnedover $14 millionwriting, publishing and selling on Leanpub.
Learn more about writing on Leanpub
Free Updates. DRM Free.
If you buy a Leanpub book, you get free updates for as long as the author updates the book! Many authors use Leanpub to publish their books in-progress, while they are writing them. All readers get free updates, regardless of when they bought the book or how much they paid (including free).
Most Leanpub books are available in PDF (for computers) and EPUB (for phones, tablets and Kindle). The formats that a book includes are shown at the top right corner of this page.
Finally, Leanpub books don't have any DRM copy-protection nonsense, so you can easily read them on any supported device.
Learn more about Leanpub's ebook formats and where to read them