Home

Awesome

markdownfmt

Coverage Status

Master :

Develop:

Format Markdown in emacs using markdownfmt

Installation

The recommended way to install markdownfmt is via MELPA:

M-x package-install markdownfmt

or Cask:

(depends-on "markdownfmt")

Usage

Run M-x markdownfmt-format-buffer to format the current buffer.

For convenience, you may bind it to a key, such as:

(define-key markdown-mode-map (kbd "C-c C-f") #'markdownfmt-format-buffer)

Alternatively, run markdownfmt before saving markdown buffers:

(add-hook 'markdown-mode-hook #'markdownfmt-enable-on-save)

Development

Cask

markdownfmt use Cask for dependencies management. Install it and retrieve dependencies :

$ curl -fsSkL https://raw.github.com/cask/cask/master/go | python
$ export PATH="$HOME/.cask/bin:$PATH"
$ cask

Testing

KeybindingDescription
<kbd>C-c , t</kbd>launch unit tests from buffer
<kbd>C-c , b</kbd>launch unit tests
<kbd>C-c , g</kbd>launch unit tests with tag (find, regexp, ...)

If you want to launch a single unit test, add a specify tag :

(ert-deftest test-foobar ()
  :tags '(current)

And launch it using : <kbd>C-c , g</kbd> and specify tag : current

Support / Contribute

See here

Changelog

A changelog is available here.

License

See LICENSE.

Contact

Nicolas Lamirault nicolas.lamirault@gmail.com