Giter VIP home page Giter VIP logo

flycheck-mmark's Introduction

Flycheck support for MMark

License GPL 3 MELPA CI

This package provides a Flycheck checker for the 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:

(require 'flycheck-mmark)

Usage

First of all, build the 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
<SNIP … SNIP>
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, follow the link if you wish to see the installation instructions.

Next, add the following to your configuration file:

(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:

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

License

Copyright © 2018–present Mark Karpov

Distributed under GNU GPL, version 3.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.