https://github.com/alerque/vim-commonmark

CommonMark syntax for Neovim using pulldown-cmark
https://github.com/alerque/vim-commonmark

Last synced: over 1 year ago
JSON representation

CommonMark syntax for Neovim using pulldown-cmark

• Host: GitHub
• URL: https://github.com/alerque/vim-commonmark
• Owner: alerque
• License: mit
• Created: 2020-05-18T05:59:24.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-03-10T01:42:57.000Z (over 3 years ago)
• Last Synced: 2025-03-17T20:12:32.657Z (over 1 year ago)
• Language: Rust
• Size: 85 KB
• Stars: 9
• Watchers: 3
• Forks: 2
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
# Vim CommonMark

[![Cargo Build](https://img.shields.io/github/workflow/status/alerque/vim-commonmark/Rust?label=Cargo+Build)](https://github.com/alerque/vim-commonmark/actions?workflow=Rust)

[![Rust Code Format](https://img.shields.io/github/workflow/status/alerque/vim-commonmark/Rustfmt?label=Rustfmt&logo=Rust)](https://github.com/alerque/vim-commonmark/actions?workflow=Rustfmt)

[![VimL Lint Status](https://github.com/alerque/vim-commonmark/workflows/Vint/badge.svg)](https://github.com/alerque/vim-commonmark/actions?workflow=Vint)

[![Lua Lint Status](https://img.shields.io/github/workflow/status/alerque/vim-commonmark/Luacheck?label=Luacheck&logo=Lua)](https://github.com/alerque/vim-commonmark/actions?workflow=Luacheck) [![Join the chat at https://gitter.im/vim-commonmark/community](https://badges.gitter.im/vim-commonmark/community.svg)](https://gitter.im/vim-commonmark/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

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!).

Defaults options are for strict CommonMark mode, but some extensions are also available (footnotes, tables, task lists, strikethrough).

```viml

" Enable all available extensions

let g:commonmark#extentions#all = 1

```

Alternatively you can enable just the extensions you want:

```viml

" Enable specific extension(s)

let g:commonmark#extensions = [ "footnotes", "strikethrough" ]

```

## Requirements

* Neovim (Support for VIM8 would be possible, contributions welcome) with Lua support

* Rust build toolchain (during development, binaries may be provided later)

* GNU Make (during development, to be replaced by VimL install function later)

## Instructions

Using `vim-plug`:

```viml

:Plug 'alerque/vim-commonmark', {'do': 'make'}

```

...or manually after installing via your usual method, run `make` from the plugin directory.

  [commonmark]: https://commonmark.org

  [pulldown-cmark]: https://github.com/raphlinus/pulldown-cmark