X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/5da9db319c1c4382c8f9f55b3bf12917f001fbd7..0c61f835a73119eb80e68d27cf95136c36aa092b:/README.md diff --git a/README.md b/README.md index 18044db..9583a43 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # Markdown Vim Mode +[![Build Status](https://travis-ci.org/plasticboy/vim-markdown.svg)](https://travis-ci.org/plasticboy/vim-markdown) + Syntax highlighting, matching rules and mappings for [the original Markdown](http://daringfireball.net/projects/markdown/) and extensions. ## Installation @@ -35,15 +37,21 @@ If you are not using any package manager, download the [tarball](https://github. ## Options -**Disable Folding** +### Disable Folding -Add the following line to your `.vimrc` to disable folding. +Add the following line to your `.vimrc` to disable folding configuration. ```vim let g:vim_markdown_folding_disabled=1 ``` -**Set Initial Foldlevel** +This option only controls vim_markdown's folding configuration. To enable/disable folding use Vim's folding configuration. + +```vim +set [no]foldenable +``` + +### 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. @@ -51,7 +59,7 @@ Add the following line to your `.vimrc` to set the initial foldlevel. This optio let g:vim_markdown_initial_foldlevel=1 ``` -**Disable Default Key Mappings** +### Disable Default Key Mappings Add the following line to your `.vimrc` to disable default key mappings. You can map them by yourself with `` mappings. @@ -59,6 +67,26 @@ Add the following line to your `.vimrc` to disable default key mappings. You can let g:vim_markdown_no_default_key_mappings=1 ``` +### Syntax extensions + +The following options control which syntax extensions will be turned on. They are off by default. + +#### LaTeX math + +Used as `$x^2$`, `$$x^2$$`, escapable as `\$x\$` and `\$\$x\$\$`. + +```vim +let g:vim_markdown_math=1 +``` + +#### YAML frontmatter + +Highlight YAML frontmatter as used by Jekyll: + +```vim +let g:vim_markdown_frontmatter=1 +``` + ## Mappings The following work on normal and visual modes: