X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/26cfc8ef05385a8b5f526c4d461d982a82b119b2..c1ed58f93d2597c2a15d709e437a45267d26b6e1:/README.md?ds=sidebyside diff --git a/README.md b/README.md index a11299b..6c043db 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,264 @@ -# Markdown Vim Mode +# Vim Markdown -Syntax highlighting and matching rules for [Markdown](http://daringfireball.net/projects/markdown/). +[![Build Status](https://travis-ci.org/plasticboy/vim-markdown.svg)](https://travis-ci.org/plasticboy/vim-markdown) + +Syntax highlighting, matching rules and mappings for [the original Markdown](http://daringfireball.net/projects/markdown/) and extensions. + +1. [Installation](#installation) +1. [Options](#options) +1. [Mappings](#mappings) +1. [Commands](#commands) +1. [Credits](#credits) +1. [License](#license) ## Installation -If you use [Pathogen](http://www.vim.org/scripts/script.php?script_id=2332)(and you should), do this: +If you use [Vundle](https://github.com/gmarik/vundle), add the following line to your `~/.vimrc`: + +```vim +Plugin 'godlygeek/tabular' +Plugin 'plasticboy/vim-markdown' +``` + +The `tabular` plugin must come *before* `vim-markdown`. + +Then run inside Vim: + +```vim +:so ~/.vimrc +:PluginInstall +``` + +If you use [Pathogen](https://github.com/tpope/vim-pathogen), do this: + +```sh +cd ~/.vim/bundle +git clone https://github.com/plasticboy/vim-markdown.git +``` + +To install without Pathogen using the Debian [vim-addon-manager](http://packages.qa.debian.org/v/vim-addon-manager.html), do this: + +```sh +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](https://github.com/plasticboy/vim-markdown/archive/master.tar.gz) and do this: + +```sh +cd ~/.vim +tar --strip=1 -zxf vim-markdown-master.tar.gz +``` + +## Options + +### Disable Folding + +Add the following line to your `.vimrc` to disable the folding configuration: + +```vim +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. + +```vim +set [no]foldenable +``` + +### Change fold style + +To fold in a style like [python-mode](https://github.com/klen/python-mode), add +the following to your `.vimrc`: + +```vim +let g:vim_markdown_folding_style_pythonic = 1 +``` + +### Set header folding level + +Folding level is a number between 1 and 6. By default, if not specified, it is set to 1. + +```vim +let g:vim_markdown_folding_level = 6 +``` + +Tip: it can be changed on the fly with: + +```vim +:let g:vim_markdown_folding_level = 1 +:edit +``` + +### Disable Default Key Mappings + +Add the following line to your `.vimrc` to disable default key mappings: + +```vim +let g:vim_markdown_no_default_key_mappings = 1 +``` + +You can also map them by yourself with `` mappings. + +### Enable TOC window auto-fit + +Allow for the TOC window to auto-fit when it's possible for it to shrink. +It never increases its default size (half screen), it only shrinks. + +```vim +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: + +```vim +let g:vim_markdown_emphasis_multiline = 0 +``` + +### Syntax Concealing + +Concealing is set for some syntax. + +For example, conceal `[link text](link url)` as just `link text`. + +To enable/disable conceal use Vim's standard conceal configuration. + +```vim +set conceallevel=2 +``` + +### Syntax extensions + +The following options control which syntax extensions will be turned on. They are off by default. + +#### LaTeX math + +Used as `$x^2$`, `$$x^2$$`, escapable as `\$x\$` and `\$\$x\$\$`. + +```vim +let g:vim_markdown_math = 1 +``` + +#### YAML Front Matter + +Highlight YAML front matter as used by Jekyll or [Hugo](https://gohugo.io/content/front-matter/). + +```vim +let g:vim_markdown_frontmatter = 1 +``` + +#### TOML Front Matter + +Highlight TOML front matter as used by [Hugo](https://gohugo.io/content/front-matter/). + +TOML syntax highlight requires [vim-toml](https://github.com/cespare/vim-toml). + +```vim +let g:vim_markdown_toml_frontmatter = 1 +``` + +#### JSON Front Matter + +Highlight JSON front matter as used by [Hugo](https://gohugo.io/content/front-matter/). + +JSON syntax highlight requires [vim-json](https://github.com/elzr/vim-json). + +```vim +let g:vim_markdown_json_frontmatter = 1 +``` + +## Mappings + +The following work on normal and visual modes: + +- `gx`: open the link under the cursor in the same browser as the standard `gx` command. `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 + + + ^ ^ ^ + 1 2 3 + + Known limitation: does not work for links that span multiple lines. + +- `]]`: go to next header. `Markdown_MoveToNextHeader` + +- `[[`: go to previous header. Contrast with `]c`. `Markdown_MoveToPreviousHeader` + +- `][`: go to next sibling header if any. `Markdown_MoveToNextSiblingHeader` + +- `[]`: go to previous sibling header if any. `Markdown_MoveToPreviousSiblingHeader` + +- `]c`: go to Current header. `Markdown_MoveToCurHeader` + +- `]u`: go to parent header (Up). `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 Markdown_MoveToParentHeader + +To disable a map use: + + map Markdown_MoveToParentHeader + +## Commands + +The following requires `:filetype plugin on`. + +- `: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`: Analogous to `:HeaderDecrease`, but increase levels instead. + +- `: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`: Format the table under the cursor [like this](http://www.cirosantilli.com/markdown-style-guide/#tables). + + Requires [Tabular](https://github.com/godlygeek/tabular). + + 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`: create a quickfix vertical window navigable table of contents with the headers. + + Hit `` on a line to jump to the corresponding line of the markdown file. + +- `:Toch`: Same as `:Toc` but in an horizontal window. + +- `:Toct`: Same as `:Toc` but in a new tab. + +- `:Tocv`: Same as `:Toc` for symmetry with `:Toch` and `:Tocv`. - $ cd ~/.vim/bundle - $ git clone https://github.com/plasticboy/vim-markdown.git +## Credits -To install without Pathogen, download the [tarball](https://github.com/plasticboy/vim-markdown/archive/master.tar.gz) and do this: +The main contributors of vim-markdown are: - $ cd ~/.vim - $ tar --strip=1 -zxf vim-markdown-master.tar.gz +- **Ben Williams** (A.K.A. **plasticboy**). The original developer of vim-markdown. [Homepage](http://plasticboy.com/). -[Homepage](http://plasticboy.com/markdown-vim-mode/) +If you feel that your name should be on this list, please make a pull request listing your contributions. ## License