X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/a9f56e2ce0a97c79ed61cb536e141453c2f92975..1311140900e9505dfab3442dfce400f10fa351b6:/README.md?ds=sidebyside diff --git a/README.md b/README.md index 93b0d98..419c26d 100644 --- a/README.md +++ b/README.md @@ -47,15 +47,21 @@ tar --strip=1 -zxf vim-markdown-master.tar.gz ## 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. @@ -63,7 +69,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. @@ -71,15 +77,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** +### Syntax extensions + +The following options control which syntax extensions will be turned on. They are off by default. -The following options control which syntax extensions will be turned on. +#### LaTeX math -LaTeX math: `$ $`, `$$ $$`, escapable as `\$ \$` and `\$\$ \$\$`: +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: