https://github.com/shime/emacs-livedown

Emacs plugin for Livedown.
https://github.com/shime/emacs-livedown

Last synced: 3 days ago
JSON representation

Emacs plugin for Livedown.

• Host: GitHub
• URL: https://github.com/shime/emacs-livedown
• Owner: shime
• Created: 2014-11-25T11:58:47.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2023-02-10T19:40:15.000Z (over 1 year ago)
• Last Synced: 2024-08-05T06:06:08.752Z (3 months ago)
• Language: Emacs Lisp
• Size: 13.7 KB
• Stars: 114
• Watchers: 5
• Forks: 7
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# livedown.el

Emacs plugin for [Livedown](https://github.com/shime/livedown).

![](https://twobucks.co/assets/emacs-livedown.gif)

## Installation

First make sure you have [node](http://nodejs.org/) with [npm](https://www.npmjs.org/) installed.

Then install `livedown` with

    $ npm install -g livedown

Then install this plugin with

```shell

git clone https://github.com/shime/emacs-livedown.git ~/.emacs.d/emacs-livedown

cat <> ~/.emacs.d/init.el

(add-to-list 'load-path (expand-file-name "~/.emacs.d/emacs-livedown"))

(require 'livedown)

EOF

```

## Configuration

This plugin uses some configurable variables, with the following defaults

```elisp

(custom-set-variables

 '(livedown-autostart nil) ; automatically open preview when opening markdown files

 '(livedown-open t)        ; automatically open the browser window

 '(livedown-port 1337)     ; port for livedown server

 '(livedown-browser nil))  ; browser to use

```

Make sure to place them before the `require` line in your `init.el`.

You can also call the functions manually with

```elisp

M-x livedown-preview

M-x livedown-kill

```

Or for bonus points, define a keybinding with

```elisp

(global-set-key (kbd "C-M-m") 'livedown-preview)

```

## License

MIT