]> git.madduck.net Git - etc/vim.git/blobdiff - README.md

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Make contributing headers h2 like README
[etc/vim.git] / README.md
index da77a07bb19a247da30f426c4fc81d44bba2a929..ec200b6d32510a46f02435911c67811d5d601325 100644 (file)
--- a/README.md
+++ b/README.md
@@ -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.
@@ -76,7 +76,22 @@ 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
+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
@@ -84,44 +99,50 @@ let g:vim_markdown_folding_style_pythonic=1
 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 `<Plug>` mappings.
 
-### Syntax extensions
-
-The following options control which syntax extensions will be turned on. They are off by default.
+### Enable TOC window auto-fit
 
-#### LaTeX math
-
-Used as `$x^2$`, `$$x^2$$`, escapable as `\$x\$` and `\$\$x\$\$`.
+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_math=1
+let g:vim_markdown_toc_autofit = 1
 ```
 
-#### YAML frontmatter
+### Syntax Concealing
 
-Highlight YAML frontmatter as used by Jekyll:
+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
-let g:vim_markdown_frontmatter=1
+set conceallevel = 2
 ```
 
-#### Folding level
+### Syntax extensions
+
+The following options control which syntax extensions will be turned on. They are off by default.
 
-Folding level is a number between 1 and 6. By default, if not specified, it is set to 1.
+#### LaTeX math
+
+Used as `$x^2$`, `$$x^2$$`, escapable as `\$x\$` and `\$\$x\$\$`.
 
 ```vim
-let g:vim_markdown_folding_level = 6
+let g:vim_markdown_math = 1
 ```
 
-Tip: it can be changed on the fly with:
+#### YAML frontmatter
+
+Highlight YAML frontmatter as used by Jekyll:
 
 ```vim
-:let g:vim_markdown_folding_level = 1
-:edit
+let g:vim_markdown_frontmatter = 1
 ```
 
 
@@ -167,6 +188,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.