Guide to Markdown Mode for Emacs (The Book + PDF Reference Card)
Guide to Markdown Mode for Emacs
About the Book
The Guide to Markdown Mode for Emacs is a complete reference for the markdown-mode package for users of all levels. The book supplements the online documentation by providing more details about installation, configuration, and movement and editing commands. There are examples throughout that show the Emacs way of editing as it relates to Markdown. Additionally, the book covers more advanced usage such as subtree and structure editing, defun and page movement, marking, narrowing, region management, imenu, etc. It goes beyond the basic documentation by also discussing interaction with other packages such as Flyspell mode, CriticMarkup mode, Pandoc mode, Deft, HTML as Markdown mode, MathJax, and more. Finally, it also contains tips and tricks for custom configuration options such as custom CSS stylesheets, using pre- and post-processors, customizing faces, keeping notes in a local wiki, etc.
You can support the project by purchasing the book on Leanpub, where it is available in PDF, EPUB, and Mobi formats for offline reading on mobile devices. When you buy the book on Leanpub, you will also receive a high-resolution PDF quick reference card (half-letter size for easy printing). Alternatively, you can purchase the book on the Apple iBooks Store or the Amazon Kindle Store or the paperback version on Amazon. The source code for the book is available on GitHub. All ebook editions, whether purchased on Leanpub or elsewhere, will receive free updates.
- 1.1 Quick Reference
- 1.2 Markdown
- 1.3 History
- 1.4 Acknowledgments
2. Installation & Configuration
- 2.1 Installation Methods
- 2.2 Configuring Markdown
- 2.3 Customization
3. Movement & Editing
- 3.1 Headings
- 3.2 Paragraphs
- 3.3 Blockquotes
- 3.4 Lists
- 3.5 Paragraph & Block Movement
- 3.6 Indentation
- 3.7 Code Blocks
- 3.8 Horizontal Rules
- 3.9 Emphasis: Italic & Bold
- 3.10 Inline Code
- 3.11 Links & Images
- 3.12 Line Breaks
- 3.13 Killing Elements
- 3.14 Markdown Do
- 3.15 Markup Promotion & Demotion
- 3.16 Markup Completion
- 3.17 Markdown Maintenance Commands
- 4.1 Fenced Code Blocks
- 4.2 Footnotes
- 4.3 Definition Lists
- 4.4 Comments
- 4.5 Task List Items (Checkboxes)
- 4.6 Subscripts and Superscripts
- 4.7 Metadata
- 4.8 Wiki Links
- 4.9 Mathematical Expressions (LaTeX)
- 4.10 GitHub Flavored Markdown (GFM) Mode
5. Previewing & Exporting Files
- 5.1 Markup Hiding
- 5.2 Compiling to a Temporary Buffer or the Kill Ring
- 5.3 Static HTML Preview
- 5.4 Static HTML Export & View
- 5.5 Live Preview Mode
- 5.6 Opening in a Standalone Markdown Previewer
- 5.7 Preview & Export Customization
- 6.1 Using Markdown Mode with Other File Extensions
- 6.2 Switching and Toggling Markup
- 6.3 Linking to or Including Custom CSS
- 6.4 Imenu and Imenu-List
- 6.5 File Local Variables
- 6.6 Generating a Table of Contents
- 6.7 Highlighting and Preserving Whitespace
- 6.8 Using Flyspell with Markdown Mode
- 6.9 Keeping Notes in a Local Wiki
- 6.10 Integration with Deft Mode
- 6.11 MathJax Integration
- 6.12 Using Pre- and Post-Processors
- 6.13 Using a Custom Web Browser
- 6.14 Using Marked 2 as a Standalone Previewer
- 6.15 Pandoc Mode
- 6.16 R Markdown
- 6.17 Tracking Changes with CriticMarkup Mode
- 6.18 Editing HTML as Markdown
- 6.19 Editing Markdown Tables with Org Table Mode
7. Markdown Mode Development
- 7.1 Testing the Development Version
- 7.2 Reporting Bugs and Issues
- 7.3 Submitting Patches or GitHub Pull Requests
- 8.1 Looking Back and Looking Ahead
- 8.2 Further Reading
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.
El Manual del ManagerKeyvan Akbary, Félix López, and Álvaro Salazar
¿Has deseado alguna vez el haber tenido una buena introducción al rol del Engineering Manager? En este libro aprenderás lo necesario para ejercer el rol de una manera efectiva: Expectativas y Responsabilidades del Rol, 1-1s, Ayudar a Crecer, Objetivos, Planes de Carrera, Cultura, Feedback, Contratación, Cultura de Producto y mucho más.
Functional Design and ArchitectureAlexander Granin
Software Design in Functional Programming, Design Patterns and Practices, Methodologies and Application Architectures. How to build real software in Haskell with less efforts and low risks. The first complete source of knowledge.
Ansible for KubernetesJeff Geerling
Ansible is a powerful infrastructure automation tool. Kubernetes is a powerful application deployment platform. Learn how to use these tools to automate massively-scalable, highly-available infrastructure.
Ansible for DevOpsJeff Geerling
Ansible is a simple, but powerful, server and configuration management tool. Learn to use Ansible effectively, whether you manage one server—or thousands.
Practical FP in Scala: A hands-on approachGabriel Volpe
A practical book aimed for those familiar with functional programming in Scala who are yet not confident about architecting an application from scratch.
Together, we will develop a purely functional application using the best libraries in the Cats ecosystem, while learning about design patterns and best practices.
Tame your Work FlowSteve Tendon and Daniel Doiron
Do you need a high performance enterprise governance approach improving management, execution and delivery while dealing with multiple projects/products, events, stakeholders and teams? Giving you better bottom line results, faster time to market, less work, better predictability, happier employees, and delighted clients? Then learn about TameFlow!
C++ Best PracticesJason Turner
Level up your C++, get the tools working for you, eliminate common problems, and move on to more exciting things!
Cloud StrategyGregor Hohpe
“Strategy is the difference between making a wish and making it come true.” A successful migration to the cloud shouldn’t be driven by wishes, but guided by a sound strategy, frameworks, and decision models. This book tells you how—without becoming superficial nor getting lost in technology and product details.
Machine Learning EngineeringAndriy Burkov
"If you intend to use machine learning to solve business problems at scale, I'm delighted you got your hands on this book."
—Cassie Kozyrkov, Chief Decision Scientist at Google
"Foundational work about the reality of building machine learning models in production."
—Karolis Urbonas, Head of Machine Learning and Science at Amazon
Composing SoftwareEric Elliott
All software design is composition: the act of breaking complex problems down into smaller problems and composing those solutions. Most developers have a limited understanding of compositional techniques. It's time for that to change.
11 BooksThe Quality Software Bundle is for managers, would-be managers, and any of us who find themselves being managed and confused. This comprehensive bundle covers the entire span of software development approaches, from hacking through waterfall, cascade, prototyping, Iterative enhancement, reusable code, off-the-shelf, to Agile teams. The bundle...
The Node.js Bundle
3 BooksThis bundle combines three bestselling Leanpub Node.js books into a package that gives you everything you need to get started with developing Node.js applications at an unbeatable price.
The Tester's Library
8 BooksThe Tester's Library consists of eight five-star books that every software tester should read and re-read. As bound books, this collection would cost over $200. Even as e-books, their price would exceed $80, but in this bundle, their cost is only $49.99. Here are the books, and why they should be in your library: Perfect Software and Other...
11 BooksIn this bundle, you will find 10 different agile books. They are about different aspects of being agile. - finding a job - doing coding dojo's - Retrospectives - Personal kanban - a non-typical coaching book and even a book that gives you an insight in the lives of some agile people.
WTFlop 6M + HU - Beta Bundle
Marionette.js A to Z
Complete Scala Bundle
3 BooksScala is a general-purpose programming language and it's getting extremely popular these days. Some say that learning Scala could be a challenging task. My experience, however, suggests that this is actually a myth that has very little to do with reality. With the right approach, learning Scala can be easy, fun and rewarding.The first book from...
Build A Better Backbone App
3 BooksThe best way to learn new development skills is through experience, but that takes time you don't have.Get the best of both worlds with this bundle: you'll learn how to produce modern web applications by learning from experienced developers like Derick Bailey and David Sulc. BackboneJS is one of the favorite tools on the web today, but it...
People Skills—Soft but Difficult
7 BooksPerhaps you've been told that "lack of people skills" has been holding you back. No wonder: you may have had hundreds of hours of technical training, but little or no "people skills" guidance.You've heard it said that people skills are "soft," whereas technical skills are "hard." For you, though, technical skills are "easy," but people skills...
SurviveJS - Webpack + React
2 BooksGet both SurviveJS - Webpack and SurviveJS - React for a single price!