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 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...
80% Royalties. Earn $16 on a $20 book.
We pay 80% royalties. That's not a typo: you earn $16 on a $20 sale. If we sell 5000 non-refunded copies of your book or course for $20, you'll earn $80,000.
(Yes, some authors have already earned much more than that on Leanpub.)
In fact, authors have earnedover $12 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.