]> git.madduck.net Git - etc/vim.git/blobdiff - doc/vim-markdown.txt

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Squashed '.vim/bundle/vim-markdown/' changes from da5a7ac9..8f6cb3a6
[etc/vim.git] / doc / vim-markdown.txt
index 001a6b7599987f1611933a93a062a89ad1bb8ab6..3e843571ab6dfc51c01b1752d74b28242aa9db8a 100644 (file)
@@ -55,7 +55,7 @@ Installation ~
 If you use Vundle [2], add the following lines to your '~/.vimrc':
 >
   Plugin 'godlygeek/tabular'
 If you use Vundle [2], add the following lines to your '~/.vimrc':
 >
   Plugin 'godlygeek/tabular'
-  Plugin 'plasticboy/vim-markdown'
+  Plugin 'preservim/vim-markdown'
 <
 The 'tabular' plugin must come _before_ 'vim-markdown'.
 
 <
 The 'tabular' plugin must come _before_ 'vim-markdown'.
 
@@ -67,11 +67,11 @@ Then run inside Vim:
 If you use Pathogen [3], do this:
 >
   cd ~/.vim/bundle
 If you use Pathogen [3], do this:
 >
   cd ~/.vim/bundle
-  git clone https://github.com/plasticboy/vim-markdown.git
+  git clone https://github.com/preservim/vim-markdown.git
 <
 To install without Pathogen using the Debian vim-addon-manager [4], do this:
 >
 <
 To install without Pathogen using the Debian vim-addon-manager [4], do this:
 >
-  git clone https://github.com/plasticboy/vim-markdown.git
+  git clone https://github.com/preservim/vim-markdown.git
   cd vim-markdown
   sudo make install
   vim-addon-manager install markdown
   cd vim-markdown
   sudo make install
   vim-addon-manager install markdown
@@ -102,9 +102,13 @@ The following commands are useful to open and close folds:
                                                               *vim-markdown-zM*
 - 'zM': folds everything all the way
                                                               *vim-markdown-za*
                                                               *vim-markdown-zM*
 - 'zM': folds everything all the way
                                                               *vim-markdown-za*
-- 'za': open a fold your cursor is on
+- 'za': toggle a fold your cursor is on
                                                               *vim-markdown-zA*
                                                               *vim-markdown-zA*
-- 'zA': open a fold your cursor is on recursively
+- 'zA': toggle a fold your cursor is on recursively
+                                                              *vim-markdown-zo*
+- 'zo': open a fold your cursor is on
+                                                              *vim-markdown-zO*
+- 'zO': open a fold your cursor is on recursively
                                                               *vim-markdown-zc*
 - 'zc': close a fold your cursor is on
                                                               *vim-markdown-zC*
                                                               *vim-markdown-zc*
 - 'zc': close a fold your cursor is on
                                                               *vim-markdown-zC*
@@ -161,8 +165,9 @@ Change fold style ~
 >
   let g:vim_markdown_folding_style_pythonic = 1
 <
 >
   let g:vim_markdown_folding_style_pythonic = 1
 <
-  Level 1 heading which is served as a document title is not folded.
-  'g:vim_markdown_folding_level' setting is not active with this fold style.
+  'g:vim_markdown_folding_level' setting (default 1) is set to 'foldlevel'.
+  Thus level 1 heading which is served as a document title is expanded by
+  default.
 
                                              *g:vim_markdown_override_foldtext*
 - 'g:vim_markdown_override_foldtext'
 
                                              *g:vim_markdown_override_foldtext*
 - 'g:vim_markdown_override_foldtext'
@@ -256,6 +261,13 @@ Syntax Concealing ~
 >
   let g:tex_conceal = ""
   let g:vim_markdown_math = 1
 >
   let g:tex_conceal = ""
   let g:vim_markdown_math = 1
+<
+                                           *g:vim_markdown_conceal_code_blocks*
+- 'g:vim_markdown_conceal_code_blocks'
+
+  Disabling conceal for code fences requires an additional setting:
+>
+  let g:vim_markdown_conceal_code_blocks = 0
 <
 -------------------------------------------------------------------------------
                                      *vim-markdown-fenced-code-block-languages*
 <
 -------------------------------------------------------------------------------
                                      *vim-markdown-fenced-code-block-languages*
@@ -482,6 +494,30 @@ Change how to open new files ~
 >
   let g:vim_markdown_edit_url_in = 'tab'
 <
 >
   let g:vim_markdown_edit_url_in = 'tab'
 <
+-------------------------------------------------------------------------------
+                                    *vim-markdown-support-borderless-tables*
+Support borderless tables ~
+
+                                              *g:vim_markdown_borderless_table*
+- 'g:vim_markdown_borderless_table'
+
+  Add support for borderless tables, such as:
+>
+  header 1|header 2
+  --|--
+  data 1|data 2
+<
+  if set to 1:
+>
+  let g:vim_markdown_borderless_table = 1
+<
+  the table would be formatted as usual:
+>
+  | header 1 | header 2 |
+  |----------|----------|
+  | data 1   | data 2   |
+<
+
 ===============================================================================
                                                         *vim-markdown-mappings*
 Mappings ~
 ===============================================================================
                                                         *vim-markdown-mappings*
 Mappings ~
@@ -517,7 +553,7 @@ The following work on normal and visual modes:
 - ']]': go to next header. '<Plug>Markdown_MoveToNextHeader'
 
                                                               *vim-markdown-[[*
 - ']]': go to next header. '<Plug>Markdown_MoveToNextHeader'
 
                                                               *vim-markdown-[[*
-- '[[': go to previous header. Contrast with ']c'.
+- '[[': go to previous header. Contrast with ']h'.
   '<Plug>Markdown_MoveToPreviousHeader'
 
                                                               *vim-markdown-][*
   '<Plug>Markdown_MoveToPreviousHeader'
 
                                                               *vim-markdown-][*
@@ -528,8 +564,8 @@ The following work on normal and visual modes:
 - '[]': go to previous sibling header if any.
   '<Plug>Markdown_MoveToPreviousSiblingHeader'
 
 - '[]': go to previous sibling header if any.
   '<Plug>Markdown_MoveToPreviousSiblingHeader'
 
-                                                              *vim-markdown-]c*
-- ']c': go to Current header. '<Plug>Markdown_MoveToCurHeader'
+                                                              *vim-markdown-]h*
+- ']h': go to Current header. '<Plug>Markdown_MoveToCurHeader'
 
                                                               *vim-markdown-]u*
 - ']u': go to parent header (Up). '<Plug>Markdown_MoveToParentHeader'
 
                                                               *vim-markdown-]u*
 - ']u': go to parent header (Up). '<Plug>Markdown_MoveToParentHeader'
@@ -643,7 +679,7 @@ References ~
 [2] https://github.com/gmarik/vundle
 [3] https://github.com/tpope/vim-pathogen
 [4] http://packages.qa.debian.org/v/vim-addon-manager.html
 [2] https://github.com/gmarik/vundle
 [3] https://github.com/tpope/vim-pathogen
 [4] http://packages.qa.debian.org/v/vim-addon-manager.html
-[5] https://github.com/plasticboy/vim-markdown/archive/master.tar.gz
+[5] https://github.com/preservim/vim-markdown/archive/master.tar.gz
 [6] https://github.com/klen/python-mode
 [7] https://gohugo.io/content/front-matter/
 [8] https://github.com/cespare/vim-toml
 [6] https://github.com/klen/python-mode
 [7] https://gohugo.io/content/front-matter/
 [8] https://github.com/cespare/vim-toml