By default text emphasis works across multiple lines until a closing token is found. However, it's possible to restrict text emphasis to a single line (i.e., for it to be applied a closing token must be found on the same line). To do so:
You can adjust a new list indent. For example, you insert a single line like below:
```
* item1
```
Then if you type `o` to insert new line in vim and type `* item2`, the result will be:
```
* item1
* item2
```
vim-markdown automatically insert the indent. By default, the number of spaces of indent is 4. If you'd like to change the number as 2, just write:
```vim
let g:vim_markdown_new_list_item_indent = 2
```
### Do not require .md extensions for Markdown links
If you want to have a link like this `[link text](link-url)` and follow it for editing in vim using the `ge` command, but have it open the file "link-url.md" instead of the file "link-url", then use this option:
```vim
let g:vim_markdown_no_extensions_in_markdown = 1
```
This is super useful for GitLab and GitHub wiki repositories.
Normal behaviour would be that vim-markup required you to do this `[link text](link-url.md)`, but this is not how the Gitlab and GitHub wiki repositories work. So this option adds some consistency between the two.
### Auto-write when following link
If you follow a link like this `[link text](link-url)` using the `ge` shortcut, this option will automatically save any edits you made before moving you:
```vim
let g:vim_markdown_autowrite = 1
```
### Change default file extension
If you would like to use a file extension other than `.md` you may do so using the `vim_markdown_auto_extension_ext` variable:
```vim
let g:vim_markdown_auto_extension_ext = 'txt'
```
## Mappings
The following work on normal and visual modes:
-`gx`: open the link under the cursor in the same browser as the standard `gx` command. `<Plug>Markdown_OpenUrlUnderCursor`
The standard `gx` is extended by allowing you to put your cursor anywhere inside a link.
For example, all the following cursor positions will work:
[Example](http://example.com)
^ ^ ^^ ^ ^
1 2 34 5 6
<http://example.com>
^ ^ ^
1 2 3
Known limitation: does not work for links that span multiple lines.
-`ge`: open the link under the cursor in Vim for editing. Useful for relative markdown links. `<Plug>Markdown_EditUrlUnderCursor`
The rules for the cursor position are the same as the `gx` command.
-`]]`: go to next header. `<Plug>Markdown_MoveToNextHeader`
-`[[`: go to previous header. Contrast with `]c`. `<Plug>Markdown_MoveToPreviousHeader`
-`][`: go to next sibling header if any. `<Plug>Markdown_MoveToNextSiblingHeader`
-`[]`: go to previous sibling header if any. `<Plug>Markdown_MoveToPreviousSiblingHeader`
-`]c`: go to Current header. `<Plug>Markdown_MoveToCurHeader`
-`]u`: go to parent header (Up). `<Plug>Markdown_MoveToParentHeader`
This plugin follows the recommended Vim plugin mapping interface, so to change the map `]u` to `asdf`, add to your `.vimrc`:
map asdf <Plug>Markdown_MoveToParentHeader
To disable a map use:
map <Plug><Plug>Markdown_MoveToParentHeader
## Commands
The following requires `:filetype plugin on`.
-`: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-style-guide/#tables).
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 `<Enter>` 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:
- **Ben Williams** (A.K.A. **plasticboy**). The original developer of vim-markdown. [Homepage](http://plasticboy.com/).
If you feel that your name should be on this list, please make a pull request listing your contributions.
## License
The MIT License (MIT)
Copyright (c) 2012 Benjamin D. Williams
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
