X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/8ace66328c7a2f416671b863cd842712d36c53cc..691d961a643064ee1feddba8371ff12e44678f5a:/README.md diff --git a/README.md b/README.md index 8c056ce..25b7087 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,7 @@ Syntax highlighting, matching rules and mappings for [the original Markdown](http://daringfireball.net/projects/markdown/) and extensions. 1. [Installation](#installation) +1. [Basic usage](#basic-usage) 1. [Options](#options) 1. [Mappings](#mappings) 1. [Commands](#commands) @@ -52,6 +53,37 @@ cd ~/.vim tar --strip=1 -zxf vim-markdown-master.tar.gz ``` +## Basic usage + +### Folding + +Folding is enabled for headers by default. + +The following commands are useful to open and close folds: + +- `zr`: reduces fold level throughout the buffer +- `zR`: opens all folds +- `zm`: increases fold level throughout the buffer +- `zM`: folds everything all the way +- `za`: open a fold your cursor is on +- `zA`: open a fold your cursor is on recursively +- `zc`: close a fold your cursor is on +- `zC`: close a fold your cursor is on recursively + +[Options](#options) are available to disable folding or change folding style. + +Try `:help fold-expr` and `:help fold-commands` for details. + +### Concealing + +Concealing is set for some syntax such as bold, italic, code block and link. + +Concealing lets you conceal text with other text. The actual source text is not modified. If you put your cursor on the concealed line, the conceal goes away. + +[Options](#options) are available to disable or change concealing. + +Try `:help concealcursor` and `:help conceallevel` for details. + ## Options ### Disable Folding @@ -245,6 +277,14 @@ JSON syntax highlight requires [vim-json](https://github.com/elzr/vim-json). let g:vim_markdown_json_frontmatter = 1 ``` +#### Strikethrough + +Strikethrough uses two tildes. `~~Scratch this.~~` + +```vim +let g:vim_markdown_strikethrough = 1 +``` + ### Adjust new list item indent You can adjust a new list indent. For example, you insert a single line like below: @@ -293,6 +333,30 @@ If you would like to use a file extension other than `.md` you may do so using t 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: