Guide to Markdown Mode for Emacs
Guide to Markdown Mode for Emacs (The Book + PDF Reference Card)
$9.99
Minimum price
$15.99
Suggested price
Guide to Markdown Mode for Emacs

Last updated on 2017-08-31

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

Table of Contents

  • 1. Introduction
    • 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. Extensions
    • 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. Tips
    • 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. Conclusion
    • 8.1 Looking Back and Looking Ahead
    • 8.2 Further Reading
  • Notes

About the Author

Jason R. Blevins
Jason R. Blevins

Author and maintainer of Markdown Mode and Deft for Emacs.

http://jblevins.org/

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...

Write and Publish on Leanpub

Authors and publishers use Leanpub to publish amazing in-progress and completed ebooks, just like this one. You can use Leanpub to write, publish and sell your book as well! 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. It really is that easy.

Learn more about writing on Leanpub