Leanpub Header

Skip to main content

Guide to Markdown Mode for Emacs

To celebrate Markdown Mode's 10th birthday, this comprehensive Guide from the package author and maintainer covers everything from the basics to advanced editing commands, customization, interactions with other packages, and useful tips and tricks to make writing and publishing with Markdown more enjoyable and efficient.

Minimum price

$7.99

$12.99

You pay

$12.99

Author earns

$10.39
$

...Or Buy With Credits!

You can get credits with a paid monthly or annual Reader Membership, or you can buy them here.
PDF
EPUB
WEB
402
Readers
104
Pages
21,702Words
About

About

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.

Share this book

License

Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License

Author

About the Author

Jason R. Blevins

Author and maintainer of Markdown Mode and Deft for Emacs.

http://jblevins.org/

Contents

Table of Contents

1.Introduction

  1. 1.1Quick Reference
  2. 1.2Markdown
  3. 1.3History
  4. 1.4Acknowledgments

2.Installation & Configuration

  1. 2.1Installation Methods
  2. 2.2Configuring Markdown
  3. 2.3Customization

3.Movement & Editing

  1. 3.1Headings
  2. 3.2Paragraphs
  3. 3.3Blockquotes
  4. 3.4Lists
  5. 3.5Paragraph & Block Movement
  6. 3.6Indentation
  7. 3.7Code Blocks
  8. 3.8Horizontal Rules
  9. 3.9Emphasis: Italic & Bold
  10. 3.10Inline Code
  11. 3.11Links & Images
  12. 3.12Line Breaks
  13. 3.13Killing Elements
  14. 3.14Markdown Do
  15. 3.15Markup Promotion & Demotion
  16. 3.16Markup Completion
  17. 3.17Markdown Maintenance Commands

4.Extensions

  1. 4.1Fenced Code Blocks
  2. 4.2Footnotes
  3. 4.3Definition Lists
  4. 4.4Comments
  5. 4.5Task List Items (Checkboxes)
  6. 4.6Subscripts and Superscripts
  7. 4.7Metadata
  8. 4.8Wiki Links
  9. 4.9Mathematical Expressions (LaTeX)
  10. 4.10GitHub Flavored Markdown (GFM) Mode

5.Previewing & Exporting Files

  1. 5.1Markup Hiding
  2. 5.2Compiling to a Temporary Buffer or the Kill Ring
  3. 5.3Static HTML Preview
  4. 5.4Static HTML Export & View
  5. 5.5Live Preview Mode
  6. 5.6Opening in a Standalone Markdown Previewer
  7. 5.7Preview & Export Customization

6.Tips

  1. 6.1Using Markdown Mode with Other File Extensions
  2. 6.2Switching and Toggling Markup
  3. 6.3Linking to or Including Custom CSS
  4. 6.4Imenu and Imenu-List
  5. 6.5File Local Variables
  6. 6.6Generating a Table of Contents
  7. 6.7Highlighting and Preserving Whitespace
  8. 6.8Using Flyspell with Markdown Mode
  9. 6.9Keeping Notes in a Local Wiki
  10. 6.10Integration with Deft Mode
  11. 6.11MathJax Integration
  12. 6.12Using Pre- and Post-Processors
  13. 6.13Using a Custom Web Browser
  14. 6.14Using Marked 2 as a Standalone Previewer
  15. 6.15Pandoc Mode
  16. 6.16R Markdown
  17. 6.17Tracking Changes with CriticMarkup Mode
  18. 6.18Editing HTML as Markdown
  19. 6.19Editing Markdown Tables with Org Table Mode

7.Markdown Mode Development

  1. 7.1Testing the Development Version
  2. 7.2Reporting Bugs and Issues
  3. 7.3Submitting Patches or GitHub Pull Requests

8.Conclusion

  1. 8.1Looking Back and Looking Ahead
  2. 8.2Further 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...

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 earned over $14 million writing, 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

Write and Publish on Leanpub

You can use Leanpub to easily write, publish and sell in-progress and completed ebooks and online courses!

Leanpub is a powerful platform for serious authors, combining a simple, elegant writing and publishing workflow with a store focused on selling in-progress ebooks.

Leanpub is a magical typewriter for authors: just write in plain text, and to publish your ebook, just click a button. (Or, if you are producing your ebook your own way, you can even upload your own PDF and/or EPUB files and then publish with one click!) It really is that easy.

Learn more about writing on Leanpub