X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/2cd50d2ca657091c6aa787a3847284fb4cceff49..134705dfdb36470918f120645b9f140e2057d7ce:/README.md?ds=inline diff --git a/README.md b/README.md index 0d03b34..bb26e05 100644 --- a/README.md +++ b/README.md @@ -123,7 +123,7 @@ let g:vim_markdown_toc_autofit = 1 ### Text emphasis restriction to single-lines -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 (ie, for it to be applied a closing token must be found on the same line). To do so: +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: ```vim let g:vim_markdown_emphasis_multiline = 0 @@ -174,6 +174,37 @@ This will cause the following to be highlighted using the `cs` filetype syntax. Default is `['c++=cpp', 'viml=vim', 'bash=sh', 'ini=dosini']`. +### Follow named anchors + +This feature allows the `ge` command to follow named anchors in links of the form +`file#anchor` or just `#anchor`, where file may omit the `.md` extension as +usual. Two variables control its operation: + +```vim +let g:vim_markdown_follow_anchor = 1 +``` + +This tells vim-markdown whether to attempt to follow a named anchor in a link or +not. When it is 1, and only if a link can be split in two parts by the pattern +'#', then the first part is interpreted as the file and the second one as the +named anchor. This also includes urls of the form `#anchor`, for which the first +part is considered empty, meaning that the target file is the current one. After +the file is opened, the anchor will be searched. + +Default is `0`. + +```vim +let g:vim_markdown_anchorexpr = "'<<'.v:anchor.'>>'" +``` + +This expression will be evaluated substituting `v:anchor` with a quoted string +that contains the anchor to visit. The result of the evaluation will become the +real anchor to search in the target file. This is useful in order to convert +anchors of the form, say, `my-section-title` to searches of the form `My Section +Title` or `<>`. + +Default is `''`. + ### Syntax extensions The following options control which syntax extensions will be turned on. They are off by default. @@ -254,6 +285,38 @@ If you follow a link like this `[link text](link-url)` using the `ge` shortcut, 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' +``` + +### Do not automatically insert bulletpoints + +Automatically inserting bulletpoints can lead to problems when wrapping text +(see issue #232 for details), so it can be disabled: + +```vim +let g:vim_markdown_auto_insert_bullets = 0 +``` + +In that case, you probably also want to set the new list item indent to 0 as +well, or you will have to remove an indent each time you add a new list item: + +```vim +let g:vim_markdown_new_list_item_indent = 0 +``` + +### Change how to open new files + +By default when following a link the target file will be opened in your current buffer. This behavior can change if you prefer using splits or tabs by using the `vim_markdown_edit_url_in` variable. Possible values are `tab`, `vsplit`, `hsplit`, `current` opening in a new tab, vertical split, horizontal split, and current buffer respectively. Defaults to current buffer if not set: + +```vim +let g:vim_markdown_edit_url_in = 'tab' +``` + ## Mappings The following work on normal and visual modes: