liiyung/conceal_nvim

A fork of vim-markdown-concealed that uses conceal for sane reading

Markdown Concealed Vim Syntax

A variation of the vim-markdown syntax highlighting, matching rules and mappings for the original Markdown and extensions for viewing Markdown. This version cleans up Markdown syntax for easier reading using the conceal feature available in Vim 7.3 or later, and seems to make the most sense in use alongside things like less.vim and vimpager.

Concealed Completion

Below is a list (so far) of the Markdown syntax tags that currently have a supported conceal operation:

Description	Syntax Example	Concealed
Atx-style headers	# Title #	Title
Bold/Italic Star	text	text
Bold/Italic Underscore	text	text
Link	[title](url)	title→(url)
List Star	* item	• item
List Dash	- item	• item
List Plus	+ item	• item
Inline Code	`text`	text
Code Block	``` ... ```	...
Code Config Block	``` {style="..."}	```
Pre Tag	<pre>text</pre>	text
Code Tag	<code>text</code>	text
Escaped Characters	\#	#

Installation

If you use Vundle, add the following line to your ~/.vimrc:

Plugin 'prurigro/vim-markdown-concealed'

Then run inside Vim:

:so ~/.vimrc
:PluginInstall

If you use Pathogen, do this:

$ cd ~/.vim/bundle
$ git clone https://github.com/prurigro/vim-markdown-concealed.git

To install without Pathogen using the Debian vim-addon-manager, do this:

$ git clone https://github.com/prurigro/vim-markdown-concealed.git
$ cd vim-markdown-concealed
$ sudo make install
$ vim-addon-manager install mkd

If you are not using any package manager, download the tarball and do this:

$ cd ~/.vim
$ tar --strip=1 -zxf vim-markdown-concealed-master.tar.gz

Options

Disable Folding

Add the following line to your .vimrc to disable folding.

let g:vim_markdown_folding_disabled=1

Set Initial Foldlevel

Add the following line to your .vimrc to set the initial foldlevel. This option defaults to 0 (i.e. all folds are closed) and is ignored if folding is disabled.

let g:vim_markdown_initial_foldlevel=1

Disable Default Key Mappings

Add the following line to your .vimrc to disable default key mappings. You can map them by yourself with <Plug> mappings.

let g:vim_markdown_no_default_key_mappings=1

Mappings

The following work on normal and visual modes:

• ]]: go to next header. <Plug>(Markdown_MoveToNextHeader)
• [[: go to previous header. Contrast with ]c. <Plug>(Markdown_MoveToPreviousHeader)
• ][: go to next sibling header if any. <Plug>(Markdown_MoveToNextSiblingHeader)
• []: go to previous sibling header if any. <Plug>(Markdown_MoveToPreviousSiblingHeader)
• ]c: go to Current header. <Plug>(Markdown_MoveToCurHeader)
• ]u: go to parent header (Up). <Plug>(Markdown_MoveToParentHeader)

Commands

• :HeaderDecrease:

  Decrease level of all headers in buffer: h2 to h1, h3 to h2, etc.

  If range is given, only operate in the range.

  If an h1 would be decreased, abort.

  For simplicity of implementation, Setex headers are converted to Atx.

• :HeaderIncrease: Analogous to :HeaderDecrease, but increase levels instead.

• :SetexToAtx:

  Convert all Setex style headers in buffer to Atx.

  If a range is given, e.g. hit : from visual mode, only operate on the range.

• :Toc: create a quickfix vertical window navigable table of contents with the headers.

  Hit <Enter> on a line to jump to the corresponding line of the markdown file.

• :Toch: Same as :Toc but in an horizontal window.

• :Toct: Same as :Toc but in a new tab.

• :Tocv: Same as :Toc for symmetry with :Toch and Tocv.

Credits

The main contributors of vim-markdown-concealed are:

• Kevin MacMartin (prurigro): Author/Maintainer of this Concealed fork of vim-markdown.

• Ben Williams (A.K.A. plasticboy): The original developer of vim-markdown.

If you feel that your name should be on this list, please make a pull request listing your contributions.

License

The MIT License (MIT)

Copyright (c) 2012-2014 Benjamin D. Williams With Portions Copyright (C) 2014 Kevin MacMartin

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.