From: Ciro Santilli Date: Sat, 14 Mar 2015 09:12:55 +0000 (+0100) Subject: Merge pull request #177 from cirosantilli/readme-h1 X-Git-Url: https://git.madduck.net/etc/vim.git/commitdiff_plain/0da5ba9d719b818909d85bacdad2ce5d860c9e94?hp=04d0260f8e5e59ecce970692488a38e30c01526d Merge pull request #177 from cirosantilli/readme-h1 Change the README h1 to "Vim Markdown" --- diff --git a/README.md b/README.md index 84ca1fb..0a652fa 100644 --- a/README.md +++ b/README.md @@ -49,13 +49,15 @@ tar --strip=1 -zxf vim-markdown-master.tar.gz ### Disable Folding -Add the following line to your `.vimrc` to disable folding configuration. +Add the following line to your `.vimrc` to disable the folding configuration: ```vim let g:vim_markdown_folding_disabled=1 ``` -This option only controls vim_markdown's folding configuration. To enable/disable folding use Vim's folding configuration. +This option only controls Vim Markdown specific folding configuration. + +To enable/disable folding use Vim's standard folding configuration. ```vim set [no]foldenable @@ -63,12 +65,14 @@ set [no]foldenable ### 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: ```vim let g:vim_markdown_no_default_key_mappings=1 ``` +You can also map them by yourself with `` mappings. + ### Syntax extensions The following options control which syntax extensions will be turned on. They are off by default. @@ -102,7 +106,7 @@ The following work on normal and visual modes: ## Commands -- `:HeaderDecrease`: +- `:HeaderDecrease`: Decrease level of all headers in buffer: `h2` to `h1`, `h3` to `h2`, etc. @@ -112,30 +116,30 @@ The following work on normal and visual modes: For simplicity of implementation, Setex headers are converted to Atx. -- `:HeaderIncrease`: Analogous to `:HeaderDecrease`, but increase levels instead. +- `:HeaderIncrease`: Analogous to `:HeaderDecrease`, but increase levels instead. -- `:SetexToAtx`: +- `: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). +- `: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. +- `: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. +- `:Toch`: Same as `:Toc` but in an horizontal window. -- `:Toct`: Same as `:Toc` but in a new tab. +- `:Toct`: Same as `:Toc` but in a new tab. -- `:Tocv`: Same as `:Toc` for symmetry with `:Toch` and `Tocv`. +- `:Tocv`: Same as `:Toc` for symmetry with `:Toch` and `Tocv`. ## Credits diff --git a/indent/mkd.vim b/indent/mkd.vim index 21b8397..68e385a 100755 --- a/indent/mkd.vim +++ b/indent/mkd.vim @@ -3,7 +3,6 @@ let b:did_indent = 1 setlocal indentexpr=GetMkdIndent() setlocal nolisp -setlocal nosmartindent setlocal autoindent " Only define the function once diff --git a/test/map.vader b/test/map.vader index 0153269..6cf0cee 100644 --- a/test/map.vader +++ b/test/map.vader @@ -60,3 +60,16 @@ Execute (]c): AssertEqual line('.'), 3 normal ]c AssertEqual line('.'), 1 + +Given mkd; +# a + +Execute (Toc does not set nomodifiable on other files): + " Sanity check. + Assert &modifiable + + :Toc + :lclose + :edit a + + Assert &modifiable