X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/75730054adb91fd80d6eb3e6ffd76e2062fb193b..1b37c6c879c6fcdd5f96ef12b95eeda2e0b416e7:/README.md diff --git a/README.md b/README.md index a5bdbbe..0328b7f 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ To install without Pathogen using the Debian [vim-addon-manager](http://packages git clone https://github.com/plasticboy/vim-markdown.git cd vim-markdown sudo make install -vim-addon-manager install mkd +vim-addon-manager install markdown ``` If you are not using any package manager, download the [tarball](https://github.com/plasticboy/vim-markdown/archive/master.tar.gz) and do this: @@ -59,7 +59,7 @@ tar --strip=1 -zxf vim-markdown-master.tar.gz Add the following line to your `.vimrc` to disable the folding configuration: ```vim -let g:vim_markdown_folding_disabled=1 +let g:vim_markdown_folding_disabled = 1 ``` This option only controls Vim Markdown specific folding configuration. @@ -70,16 +70,61 @@ To enable/disable folding use Vim's standard folding configuration. set [no]foldenable ``` +### Change fold style + +To fold in a style like [python-mode](https://github.com/klen/python-mode), add +the following to your `.vimrc`: + +```vim +let g:vim_markdown_folding_style_pythonic = 1 +``` + +### Set header folding level + +Folding level is a number between 1 and 6. By default, if not specified, it is set to 1. + +```vim +let g:vim_markdown_folding_level = 6 +``` + +Tip: it can be changed on the fly with: + +```vim +:let g:vim_markdown_folding_level = 1 +:edit +``` + ### Disable Default Key Mappings Add the following line to your `.vimrc` to disable default key mappings: ```vim -let g:vim_markdown_no_default_key_mappings=1 +let g:vim_markdown_no_default_key_mappings = 1 ``` You can also map them by yourself with `` mappings. +### Enable TOC window auto-fit + +Allow for the TOC window to auto-fit when it's possible for it to shrink. +It never increases its default size (half screen), it only shrinks. + +```vim +let g:vim_markdown_toc_autofit = 1 +``` + +### Syntax Concealing + +Concealing is set for some syntax. + +For example, conceal `[link text](link url)` as just `link text`. + +To enable/disable conceal use Vim's standard conceal configuration. + +```vim +set conceallevel = 2 +``` + ### Syntax extensions The following options control which syntax extensions will be turned on. They are off by default. @@ -89,7 +134,7 @@ The following options control which syntax extensions will be turned on. They ar Used as `$x^2$`, `$$x^2$$`, escapable as `\$x\$` and `\$\$x\$\$`. ```vim -let g:vim_markdown_math=1 +let g:vim_markdown_math = 1 ``` #### YAML frontmatter @@ -97,7 +142,7 @@ let g:vim_markdown_math=1 Highlight YAML frontmatter as used by Jekyll: ```vim -let g:vim_markdown_frontmatter=1 +let g:vim_markdown_frontmatter = 1 ``` ## Mappings @@ -142,6 +187,8 @@ To disable a map use: ## Commands +The following requires `:filetype plugin on`. + - `:HeaderDecrease`: Decrease level of all headers in buffer: `h2` to `h1`, `h3` to `h2`, etc. @@ -160,7 +207,7 @@ To disable a map use: If a range is given, e.g. hit `:` from visual mode, only operate on the range. -- `:TableFormat`: Format the table under the cursor [like this](http://www.cirosantilli.com/markdown-styleguide/#tables). +- `:TableFormat`: Format the table under the cursor [like this](http://www.cirosantilli.com/markdown-style-guide/#tables). Requires [Tabular](https://github.com/godlygeek/tabular).