Skip to content

Instantly share code, notes, and snippets.

@jweaver

jweaver/steps.md

Forked from fredRos/steps.md
Created April 4, 2018 23:17
Show Gist options
  • Save jweaver/b7d1838deac7da2f3d251c5426067f40 to your computer and use it in GitHub Desktop.
Save jweaver/b7d1838deac7da2f3d251c5426067f40 to your computer and use it in GitHub Desktop.
Download ZIP
Setup emacs with github markdown and pandoc offline rendering
Raw
steps.md

Based on this blog.

This guide shows you how to setup emacs to render a README.md very similarly to how github will do it; except it also works offline. There are no dependencies that can't be easily installed via the package manager on ubuntu.

  1. Install emacs24, the markdown mode, and pandoc. You may need the packages emacs, emacs-goodies-el, and pandoc.
  2. Get a style sheet that resembles the github style from this gist and store it. I put it in ~/emacs.d/github-pandoc.css.
  3. Configure emacs: in .emacs, add
(add-to-list 'auto-mode-alist '("README\\.md\\'" . gfm-mode))
(setq markdown-command "pandoc -c file:///home/beaujean/.emacs.d/github-pandoc.css --from markdown_github -t html5 --mathjax --highlight-style pygments --standalone")

Now test the setup. Create a markdown file, enter these lines

Hello world

Save, then select Export & view from the Markdown menu within emacs. Your result should look like

Hello world

When editing in emacs, I find it comfortable to regularly export via C-c C-c e and have firefox reload the page on demand using the Auto Reload extension

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment