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
- 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
-
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
Authors have earned$10,270,421writing, publishing and selling on Leanpub, earning 80% royalties while saving up to 25 million pounds of CO2 and up to 46,000 trees.
Learn more about writing on Leanpub
The Leanpub 45-day 100% Happiness Guarantee
Within 45 days of purchase you can get a 100% refund on any Leanpub purchase, in two clicks.
See full terms
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), EPUB (for phones and tablets) and MOBI (for 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
Top Books
C++20
Rainer GrimmC++20 is the next big C++ standard after C++11. As C++11 did it, C++20 changes the way we program modern C++. This change is, in particular, due to the big four of C++20: ranges, coroutines, concepts, and modules.
Continuous Delivery Pipelines
Dave FarleyThis practical handbook provides a step-by-step guide for you to get the best continuous delivery pipeline for your software.
500 QUIZ MMG COMMENTATI
ALS Medicina Generale500 Quiz degli ULTIMI Concorsi di Medicina Generale (2014/2016/2017/2018/2019)
Riassunti e suddivisi per area con Griglia risposte vuota e Griglia risposte esatte Ministeriale
Commentati con link alla fonte per approfondimento e ausilio allo studio
Atomic Kotlin
Bruce Eckel and Svetlana IsakovaFor both beginning and experienced programmers! From the author of the multi-award-winning Thinking in C++ and Thinking in Java together with a member of the Kotlin language team comes a book that breaks the concepts into small, easy-to-digest "atoms," along with exercises supported by hints and solutions directly inside IntelliJ IDEA!
C++ Best Practices
Jason TurnerLevel up your C++, get the tools working for you, eliminate common problems, and move on to more exciting things!
Ansible for DevOps
Jeff GeerlingAnsible is a simple, but powerful, server and configuration management tool. Learn to use Ansible effectively, whether you manage one server—or thousands.
Discrete Mathematics for Computer Science
Alexander Shen, Alexander S. Kulikov, Vladimir Podolskii, and Aleksandr GolovnevThis book supplements the DM for CS Specialization at Coursera and contains many interactive puzzles, autograded quizzes, and code snippets. They are intended to help you to discover important ideas in discrete mathematics on your own. By purchasing the book, you will get all updates of the book free of charge when they are released.
Introducing EventStorming
Alberto BrandoliniThe deepest tutorial and explanation about EventStorming, straight from the inventor.
R Programming for Data Science
Roger D. PengThis book brings the fundamentals of R programming to you, using the same material developed as part of the industry-leading Johns Hopkins Data Science Specialization. The skills taught in this book will lay the foundation for you to begin your journey learning data science. Printed copies of this book are available through Lulu.
Visualise, document and explore your software architecture
Simon BrownA short guide to visualising, documenting and exploring your software architecture.
Top Bundles
- #1
Software Architecture for Developers: Volumes 1 & 2 - Technical leadership and communication
2 Books
"Software Architecture for Developers" is a practical and pragmatic guide to modern, lightweight software architecture, specifically aimed at developers. You'll learn:The essence of software architecture.Why the software architecture role should include coding, coaching and collaboration.The things that you really need to think about before... - #2
Software Architecture and Design Practice Reference
2 Books
Dive deeper in Software Architecture with the Design Practice Reference. Learn all about software architecture and design from the books in this bundle:Software Architecture covers topics from quality attributes to designing and modeling components, interfaces, connectors, and containers, all the way to services and microservices. The Design... - #3
CCIE Service Provider Ultimate Study Bundle
2 Books
Piotr Jablonski, Lukasz Bromirski, and Nick Russo have joined forces to deliver the only CCIE Service Provider training resource you'll ever need. This bundle contains a detailed and challenging collection of workbook labs, plus an extensively detailed technical reference guide. All of us have earned the CCIE Service Provider certification... - #7
The Python Craftsman
3 Books
The Python Craftsman series comprises The Python Apprentice, The Python Journeyman, and The Python Master. The first book is primarily suitable for for programmers with some experience of programming in another language. If you don't have any experience with programming this book may be a bit daunting. You'll be learning not just a programming... - #8
Linux Administration Complet
4 Books
Ce lot comprend les quatre volumes du Guide Linux Administration :Linux Administration, Volume 1, Administration fondamentale : Guide pratique de préparation aux examens de certification LPIC 1, Linux Essentials, RHCSA et LFCS. Administration fondamentale. Introduction à Linux. Le Shell. Traitement du texte. Arborescence de fichiers. Sécurité... - #9
Mastering Containers
2 Books
Docker and Kubernetes are taking the world by storm! These books will get you up-to-speed fast! Docker Deep Dive is over 400 pages long, and covers all objectives on the Docker Certified Associate exam.The Kubernetes Book includes everything you need to get up and running with Kubernetes!