jrblevin / markdown-mode-guide

Guide to Markdown Mode for Emacs

Guide to Markdown Mode for Emacs

By Jason R. Blevins

Ebook available on Leanpub, iBooks, and Kindle. Paperback edition available at Amazon.

About the Book

Teaser Text

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.

Summary

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 ebook on the Apple iBooks Store or the Amazon Kindle Store or the paperback version on Amazon. All ebook editions, whether purchased on Leanpub or elsewhere, will receive free updates.

Meta Description

The Guide to Markdown Mode for Emacs covers installation and configuration, advanced editing commands, customization, and useful tips and tricks.

License

Unless otherwise noted, the contents of this repository are licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

markdown-mode-guide's Issues

pandoc error in processing

I just cloned the git repo and ran make on a Debian 9.1 stretch system. The build output and error is shown below. Is this something expected, or have I missed a step?

$ make
cd manuscript && pandoc -S --highlight-style=tango -V geometry:"paperwidth=7in,paperheight=9.1in,margin=1in" --include-in-header=../preamble.tex --latex-engine=xelatex -o ../markdown-mode.pdf guide.txt
pandoc: Could not find image `http://link.url/image.jpg', skipping...
! Undefined control sequence.
l.1661 world\n

pandoc: Error producing PDF
Makefile:13: recipe for target 'markdown-mode.pdf' failed
make: *** [markdown-mode.pdf] Error 43

Physical copy?

Even though it would be frozen in time, I'd really like a physical copy. Maybe a print-on-demand service would make this possible for a small number of copies?

Any plans on updating to 2.5?

I am new to Emacs and markdown-mode is a good starting point for me as I have lots of notes in markdown format (currently using vscode ante notepad++).

I see this guide was last updated on 2017 but two releases (2.4 & 2.5) of markdown-mode have been since then. Looking at the release notes:

• v2.4 release notes
• v.2.5 release notes

Some breaking changes have been introduced that may affect the Guide; but also a lot of new features have been introduced that may not be covered by the Guide.

Are there any plans to update the Guide to v2.5?

PS: nevertheless, just got my copy through Leanpub!