X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/ab8ecf0bc73a792c60ad7a8a303290ccf89aa4e5..8f88674b604f5f743e420119633dc1e294eec1af:/doc/vim-markdown.txt?ds=inline diff --git a/doc/vim-markdown.txt b/doc/vim-markdown.txt index 2601da1..9bc972c 100644 --- a/doc/vim-markdown.txt +++ b/doc/vim-markdown.txt @@ -15,16 +15,18 @@ Contents ~ |vim-markdown-text-emphasis-restriction-to-single-lines| 7. Syntax Concealing |vim-markdown-syntax-concealing| 8. Fenced code block languages |vim-markdown-fenced-code-block-languages| - 9. Syntax extensions |vim-markdown-syntax-extensions| + 9. Follow named anchors |vim-markdown-follow-named-anchors| + 10. Syntax extensions |vim-markdown-syntax-extensions| 1. LaTeX math |vim-markdown-latex-math| 2. YAML Front Matter |vim-markdown-yaml-front-matter| 3. TOML Front Matter |vim-markdown-toml-front-matter| 4. JSON Front Matter |vim-markdown-json-front-matter| - 10. Adjust new list item indent |vim-markdown-adjust-new-list-item-indent| - 11. Do not require .md extensions for Markdown links + 11. Adjust new list item indent |vim-markdown-adjust-new-list-item-indent| + 12. Do not require .md extensions for Markdown links |vim-markdown-do-not-require-.md-extensions-for-markdown-links| - 12. Auto-write when following link + 13. Auto-write when following link |vim-markdown-auto-write-when-following-link| + 14. Change default file extension |vim-markdown-auto-extension-ext| 4. Mappings |vim-markdown-mappings| 5. Commands |vim-markdown-commands| 6. Credits |vim-markdown-credits| @@ -167,6 +169,12 @@ your '.vimrc': > let g:vim_markdown_conceal = 0 < +To disable math conceal with LaTeX math syntax enabled, add the following to +your '.vimrc': +> + let g:tex_conceal = "" + let g:vim_markdown_math = 1 +< ------------------------------------------------------------------------------- *vim-markdown-fenced-code-block-languages* Fenced code block languages ~ @@ -185,6 +193,35 @@ This will cause the following to be highlighted using the 'cs' filetype syntax. < Default is "['c++=cpp', 'viml=vim', 'bash=sh', 'ini=dosini']". +------------------------------------------------------------------------------- + *vim-markdown-follow-named-anchors* +Follow named anchors ~ + +This feature allows ge 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: +> + 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'. +> + 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 "''". + ------------------------------------------------------------------------------- *vim-markdown-syntax-extensions* Syntax extensions ~ @@ -273,6 +310,28 @@ this option will automatically save any edits you made before moving you: > let g:vim_markdown_autowrite = 1 < +------------------------------------------------------------------------------- + *vim-markdown-auto-extension-ext* +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: +> + let g:vim_markdown_auto_extension_ext = 'txt' +< +------------------------------------------------------------------------------- + *vim-markdown-edit-url-in* +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: +> + let g:vim_markdown_edit_url_in = 'tab' +< =============================================================================== *vim-markdown-mappings* Mappings ~