|
1 | 1 | # Vim CommonMark
|
2 | 2 |
|
3 |
| -[](https://github.com/alerque/vim-commonmark/actions?workflow=Rust) |
| 3 | +[](https://github.com/alerque/vim-commonmark/actions?workflow=Rust) |
4 | 4 | [](https://github.com/alerque/vim-commonmark/actions?workflow=Rustfmt)
|
5 | 5 | [](https://github.com/alerque/vim-commonmark/actions?workflow=Vint)
|
6 | 6 | [](https://github.com/alerque/vim-commonmark/actions?workflow=Luacheck)
|
7 | 7 |
|
8 |
| -Vim syntax highlighting and filetype plugin for [CommonMark][commonmark] using the [pulldown-cmark][pulldown-cmark] parser to inform the parsing. Because the syntax is not cobbled together from regular expressions but informed by a reas parser it will only ever highlight 100% valid CommonMark syntax (no false positives!). |
| 8 | +Vim syntax plugin specifically targetting [CommonMark][commonmark] using the [pulldown-cmark][pulldown-cmark] parser to inform the highlighting. Because the syntax is not cobbled together from regular expressions but informed by a real parser it will only ever highlight 100% valid CommonMark syntax (no false positives!). |
9 | 9 |
|
10 | 10 | Defaults options are for strict CommonMark mode, but some extensions are also available (footnotes, tables, task lists, strikethrough).
|
11 | 11 |
|
12 | 12 | ## Requirements
|
13 | 13 |
|
14 |
| -* Neovim (Support for VIM8 possible, contributions welcome) with Lua support |
15 |
| -* Rust build toolchain (during development, may provide binaries later) |
16 |
| -* GNU Make (at least during development, to be replaced by VimL install function later) |
| 14 | +* Neovim (Support for VIM8 would be possible, contributions welcome) with Lua support |
| 15 | +* Rust build toolchain (during development, binaries may be provided later) |
| 16 | +* GNU Make (during development, to be replaced by VimL install function later) |
17 | 17 |
|
18 | 18 | ## Instructions
|
19 | 19 |
|
20 |
| -After installing plugin as usual, `cd` to the plugin directory and run `make`. |
| 20 | +Using `vim-plug`: |
| 21 | + |
| 22 | +```viml |
| 23 | +:Plug 'alerque/vim-commonmark', {'do': 'make'} |
| 24 | +``` |
| 25 | + |
| 26 | +...or manually after installing via your usual method, run `make` from the plugin directory. |
21 | 27 |
|
22 | 28 | [commonmark]: https://commonmark.org
|
23 | 29 | [pulldown-cmark]: https://github.com/raphlinus/pulldown-cmark
|
|
0 commit comments