X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/52ae39c5624e40bf7875390631e8cbdf12099837..ec849b08fe403dba226248ff01c04a67e53fed41:/README.md diff --git a/README.md b/README.md index cc1f7ef..18044db 100644 --- a/README.md +++ b/README.md @@ -6,12 +6,15 @@ Syntax highlighting, matching rules and mappings for [the original Markdown](htt If you use [Vundle](https://github.com/gmarik/vundle), add the following line to your `~/.vimrc`: - Bundle 'plasticboy/vim-markdown' + Plugin 'godlygeek/tabular' + Plugin 'plasticboy/vim-markdown' -And then run inside Vim: +The `tabular` plugin come *before* `vim-markdown`. + +Then run inside Vim: :so ~/.vimrc - :BundleInstall + :PluginInstall If you use [Pathogen](https://github.com/tpope/vim-pathogen), do this: @@ -50,10 +53,10 @@ 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 `` mappings +Add the following line to your `.vimrc` to disable default key mappings. You can map them by yourself with `` mappings. ```vim -let g:markdown_no_default_key_mappings=1 +let g:vim_markdown_no_default_key_mappings=1 ``` ## Mappings @@ -67,6 +70,43 @@ The following work on normal and visual modes: - `]c`: go to Current header. `(Markdown_MoveToCurHeader)` - `]u`: go to parent header (Up). `(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. + +- `:TableFormat`: Format the table under the cursor [like this](http://www.cirosantilli.com/markdown-styleguide/#tables). + + Requires [Tabular](https://github.com/godlygeek/tabular). + + The input table *must* already have a separator line as the second line of the table. + That line only needs to contain the correct pipes `|`, nothing else is required. + +- `:Toc`: create a quickfix vertical window navigable table of contents with the headers. + + Hit `` 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 are: