https://github.com/vim-pandoc/vim-pandoc-syntax

pandoc markdown syntax, to be installed alongside vim-pandoc
https://github.com/vim-pandoc/vim-pandoc-syntax

Last synced: 4 months ago
JSON representation

pandoc markdown syntax, to be installed alongside vim-pandoc

• Host: GitHub
• URL: https://github.com/vim-pandoc/vim-pandoc-syntax
• Owner: vim-pandoc
• License: mit
• Created: 2013-11-04T19:24:26.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2023-11-26T07:58:38.000Z (about 1 year ago)
• Last Synced: 2024-03-26T02:58:43.594Z (11 months ago)
• Language: Vim Script
• Homepage:
• Size: 432 KB
• Stars: 420
• Watchers: 13
• Forks: 62
• Open Issues: 148
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• stars - vim-pandoc/vim-pandoc-syntax - pandoc (Tutorial / Windows Manager)
• awesome-scientific-writing - vim-pandoc-syntax - Pandoc syntax highlighting for Vim. (Word Processors)

README

        
# vim-pandoc-syntax

[![Vint](https://github.com/vim-pandoc/vim-pandoc-syntax/workflows/Vint/badge.svg)](https://github.com/vim-pandoc/vim-pandoc-syntax/actions?workflow=Vint)

Standalone pandoc syntax module, to be used alongside

[vim-pandoc](http://github.com/vim-pandoc/vim-pandoc).

Forked from the version provided by `fmoralesc/vim-pantondoc`, in turn taken

from `vim-pandoc/vim-pandoc`.

## Requirements

* A vim version with `+conceal`

* [vim-pandoc](http://github.com/vim-pandoc/vim-pandoc), to set the

  `pandoc` filetype (otherwise you'll have to set it up yourself).

## Installation

The repository follows the usual bundle structure, so it's easy to install it

using [pathogen](https://github.com/tpope/vim-pathogen),

[Vundle](https://github.com/gmarik/vundle) or NeoBundle.

For Vundle users, it should be enough to add

    Plugin 'vim-pandoc/vim-pandoc-syntax'

to `.vimrc`, and then run `:PluginInstall`.

For those who need it, a tarball is available from

[here](https://github.com/vim-pandoc/vim-pandoc-syntax/archive/master.zip).

### Standalone

If you want to use `vim-pandoc-syntax` without vim-pandoc, you'll need to tell

Vim to load it for certain files. Just add something like this to your vimrc:

~~~ vim

augroup pandoc_syntax

    au! BufNewFile,BufFilePre,BufRead *.md set filetype=markdown.pandoc

augroup END

~~~

For vimwiki users, use

~~~ vim

augroup pandoc_syntax

  autocmd! FileType vimwiki set syntax=markdown.pandoc

augroup END

~~~

## Features

* Supports most (if not all) pandoc's markdown features, including tables,

  delimited codeblocks, references, etc.

* Can handle multiple embedded languages (LaTeX, YAML headers, many languages

  in delimited codeblocks). Some commands are provided to help with this (see

  `:help pandoc-syntax-commands`)

* Pretty display using `conceal` (optional).

* Configurable (see `:help pandoc-syntax-configuration` for an overview of the

  options).

## Screenshots

![img1](http://i.imgur.com/UKXbG2V.png)

![img2](http://i.imgur.com/z8FpxRP.png)

![img3](http://i.imgur.com/ziNjQiE.png)

![img4](http://i.imgur.com/UKoOxzP.png)