+*vim-markdown* Vim Markdown
+
+===============================================================================
+Contents ~
+
+ 1. Introduction |vim-markdown-introduction|
+ 2. Installation |vim-markdown-installation|
+ 3. Options |vim-markdown-options|
+ 1. Disable Folding |vim-markdown-disable-folding|
+ 2. Change fold style |vim-markdown-change-fold-style|
+ 3. Disable Default Key Mappings |vim-markdown-disable-default-key-mappings|
+ 4. Syntax extensions |vim-markdown-syntax-extensions|
+ 1. LaTeX math |vim-markdown-latex-math|
+ 2. YAML frontmatter |vim-markdown-yaml-frontmatter|
+ 4. Mappings |vim-markdown-mappings|
+ 5. Commands |vim-markdown-commands|
+ 6. Credits |vim-markdown-credits|
+ 7. License |vim-markdown-license|
+ 8. References |vim-markdown-references|
+
+===============================================================================
+ *vim-markdown-introduction*
+Introduction ~
+
+Syntax highlighting, matching rules and mappings for the original Markdown [1]
+and extensions.
+
+===============================================================================
+ *vim-markdown-installation*
+Installation ~
+
+If you use Vundle [2], add the following line to your '~/.vimrc':
+>
+ Plugin 'godlygeek/tabular'
+ Plugin 'plasticboy/vim-markdown'
+<
+The 'tabular' plugin must come _before_ 'vim-markdown'.
+
+Then run inside Vim:
+>
+ :so ~/.vimrc
+ :PluginInstall
+<
+If you use Pathogen [3], do this:
+>
+ cd ~/.vim/bundle
+ git clone https://github.com/plasticboy/vim-markdown.git
+<
+To install without Pathogen using the Debian vim-addon-manager [4], do this:
+>
+ git clone https://github.com/plasticboy/vim-markdown.git
+ cd vim-markdown
+ sudo make install
+ vim-addon-manager install markdown
+<
+If you are not using any package manager, download the tarball [5] and do this:
+>
+ cd ~/.vim
+ tar --strip=1 -zxf vim-markdown-master.tar.gz
+<
+===============================================================================
+ *vim-markdown-options*
+Options ~
+
+-------------------------------------------------------------------------------
+ *vim-markdown-disable-folding*
+Disable Folding ~
+
+Add the following line to your '.vimrc' to disable the folding configuration:
+>
+ let g:vim_markdown_folding_disabled=1
+<
+This option only controls Vim Markdown specific folding configuration.
+
+To enable/disable folding use Vim's standard folding configuration.
+>
+ set [no]foldenable
+<
+-------------------------------------------------------------------------------
+ *vim-markdown-change-fold-style*
+Change fold style ~
+
+To fold in a style like python-mode [6], add the following to your '.vimrc':
+>
+ let g:vim_markdown_folding_style_pythonic=1
+<
+-------------------------------------------------------------------------------
+ *vim-markdown-disable-default-key-mappings*
+Disable Default Key Mappings ~
+
+Add the following line to your '.vimrc' to disable default key mappings:
+>
+ let g:vim_markdown_no_default_key_mappings=1
+<
+You can also map them by yourself with '<Plug>' mappings.
+
+-------------------------------------------------------------------------------
+ *vim-markdown-syntax-extensions*
+Syntax extensions ~
+
+The following options control which syntax extensions will be turned on. They
+are off by default.
+
+-------------------------------------------------------------------------------
+ *vim-markdown-latex-math*
+LaTeX math ~
+
+Used as '$x^2$', '$$x^2$$', escapable as '\$x\$' and '\$\$x\$\$'.
+>
+ let g:vim_markdown_math=1
+<
+-------------------------------------------------------------------------------
+ *vim-markdown-yaml-frontmatter*
+YAML frontmatter ~
+
+Highlight YAML frontmatter as used by Jekyll:
+>
+ let g:vim_markdown_frontmatter=1
+<
+===============================================================================
+ *vim-markdown-mappings*
+Mappings ~
+
+The following work on normal and visual modes:
+
+ *gx*
+- '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.
+
+ *]]*
+- ']]': 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*
+- ']c': go to Current header. '<Plug>Markdown_MoveToCurHeader'
+
+ *]u*
+- ']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
+<
+===============================================================================
+ *vim-markdown-commands*
+Commands ~
+
+ *:HeaderDecrease*
+- ':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*
+- ':HeaderIncrease': Analogous to ':HeaderDecrease', but increase levels
+ instead.
+
+ *:SetexToAtx*
+- ':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*
+- ':TableFormat': Format the table under the cursor like this [7].
+
+ Requires Tabular [8].
+
+ 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*
+- ':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*
+- ':Toch': Same as ':Toc' but in an horizontal window.
+
+ *:Toct*
+- ':Toct': Same as ':Toc' but in a new tab.
+
+ *:Tocv*
+- ':Tocv': Same as ':Toc' for symmetry with ':Toch' and 'Tocv'.
+
+===============================================================================
+ *vim-markdown-credits*
+Credits ~
+
+The main contributors of vim-markdown are:
+
+- **Ben Williams** (A.K.A. **plasticboy**). The original developer of vim-
+ markdown. Homepage [9].
+
+If you feel that your name should be on this list, please make a pull request
+listing your contributions.
+
+===============================================================================
+ *vim-markdown-license*
+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.
+
+===============================================================================
+ *vim-markdown-references*
+References ~
+
+[1] http://daringfireball.net/projects/markdown/
+[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
+[6] https://github.com/klen/python-mode
+[7] http://www.cirosantilli.com/markdown-styleguide/#tables
+[8] https://github.com/godlygeek/tabular
+[9] http://plasticboy.com/
+
+vim: ft=help
projects / etc / vim.git / commitdiff