https://github.com/mmark-md/flycheck-mmark

Flycheck checker for the MMark markdown processor
https://github.com/mmark-md/flycheck-mmark

emacs flycheck markdown mmark

Last synced: 3 months ago
JSON representation

Flycheck checker for the MMark markdown processor

• Host: GitHub
• URL: https://github.com/mmark-md/flycheck-mmark
• Owner: mmark-md
• Created: 2018-01-10T15:43:44.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2024-05-20T18:09:13.000Z (6 months ago)
• Last Synced: 2024-06-18T13:50:35.965Z (5 months ago)
• Topics: emacs, flycheck, markdown, mmark
• Language: Emacs Lisp
• Homepage:
• Size: 19.5 KB
• Stars: 5
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# Flycheck support for MMark

[![License GPL 3](https://img.shields.io/badge/license-GPL_3-green.svg)](http://www.gnu.org/licenses/gpl-3.0.txt)

[![MELPA](https://melpa.org/packages/flycheck-mmark-badge.svg)](https://melpa.org/#/flycheck-mmark)

![CI](https://github.com/mmark-md/flycheck-mmark/workflows/CI/badge.svg?branch=master)

This package provides a [Flycheck](http://www.flycheck.org) checker for the

[MMark](https://github.com/mmark-md/mmark) markdown processor.

## Installation

The package is available via MELPA, so you can just type `M-x

package-install RET flycheck-mmark RET`.

If you would like to install the package manually, download or clone it and

put on Emacs' `load-path`. Then you can require it in your init file like

this:

```emacs-lisp

(require 'flycheck-mmark)

```

## Usage

First of all, build the [`mmark-cli`](https://github.com/mmark-md/mmark-cli)

executable and place it on your `PATH`. The easiest way to do that is

currently the following:

```

$ git clone https://github.com/mmark-md/mmark-cli.git mmark-cli

Cloning into 'mmark-cli'...

remote: Counting objects: 63, done.

remote: Compressing objects: 100% (36/36), done.

remote: Total 63 (delta 29), reused 51 (delta 17), pack-reused 0

Unpacking objects: 100% (63/63), done.

$ cd mmark-cli

$ stack build --copy-bins

Copied executables to /home/mark/.local/bin:

- mmark

$ mmark --version

mmark 0.0.1.0 master e60cc92b88e0069ce296d09ef30feecef83fa03e

using mmark     (library) 0.0.5.0

using mmark-ext (library) 0.1.0.0

```

For this you'll need

[Stack](https://docs.haskellstack.org/en/stable/README/), follow the link if

you wish to see the installation instructions.

Next, add the following to your configuration file:

```emacs-lisp

(eval-after-load 'flycheck

  '(add-hook 'flycheck-mode-hook #'flycheck-mmark-setup))

```

Also make sure that you enable the `flycheck-mode` minor mode itself in the

`markdown-mode`, this can be done for example like this:

```emacs-lisp

(add-hook 'markdown-mode-hook #'flycheck-mode)

```

## License

Copyright © 2018–present Mark Karpov

Distributed under GNU GPL, version 3.