From: Ciro Santilli Date: Mon, 6 Oct 2014 10:02:20 +0000 (+0200) Subject: Merge pull request #134 from cirosantilli/readme-uniform-codeblocks X-Git-Url: https://git.madduck.net/etc/vim.git/commitdiff_plain/7046e0dd612f31d02c954b96915dd00866147572?ds=sidebyside;hp=-c Merge pull request #134 from cirosantilli/readme-uniform-codeblocks Use a single code block style on README. --- 7046e0dd612f31d02c954b96915dd00866147572 diff --combined README.md index 9583a43,93b0d98..419c26d --- a/README.md +++ b/README.md @@@ -8,50 -8,54 +8,60 @@@ Syntax highlighting, matching rules an If you use [Vundle](https://github.com/gmarik/vundle), add the following line to your `~/.vimrc`: - Plugin 'godlygeek/tabular' - Plugin 'plasticboy/vim-markdown' + ```vim + Plugin 'godlygeek/tabular' + Plugin 'plasticboy/vim-markdown' + ``` - The `tabular` plugin come *before* `vim-markdown`. + The `tabular` plugin must come *before* `vim-markdown`. Then run inside Vim: - :so ~/.vimrc - :PluginInstall + ```vim + :so ~/.vimrc + :PluginInstall + ``` If you use [Pathogen](https://github.com/tpope/vim-pathogen), do this: - $ cd ~/.vim/bundle - $ git clone https://github.com/plasticboy/vim-markdown.git + ```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: - $ git clone https://github.com/plasticboy/vim-markdown.git - $ cd vim-markdown - $ sudo make install - $ vim-addon-manager install mkd + ```sh + git clone https://github.com/plasticboy/vim-markdown.git + cd vim-markdown + sudo make install + vim-addon-manager install mkd + ``` If you are not using any package manager, download the [tarball](https://github.com/plasticboy/vim-markdown/archive/master.tar.gz) and do this: - $ cd ~/.vim - $ tar --strip=1 -zxf vim-markdown-master.tar.gz + ```sh + cd ~/.vim + tar --strip=1 -zxf vim-markdown-master.tar.gz + ``` ## Options -**Disable Folding** +### Disable Folding -Add the following line to your `.vimrc` to disable folding. +Add the following line to your `.vimrc` to disable folding configuration. ```vim let g:vim_markdown_folding_disabled=1 ``` -**Set Initial Foldlevel** +This option only controls vim_markdown's folding configuration. To enable/disable folding use Vim's folding configuration. + +```vim +set [no]foldenable +``` + +### Set Initial Foldlevel Add the following line to your `.vimrc` to set the initial foldlevel. This option defaults to 0 (i.e. all folds are closed) and is ignored if folding is disabled. @@@ -59,7 -63,7 +69,7 @@@ let g:vim_markdown_initial_foldlevel=1 ``` -**Disable Default Key Mappings** +### Disable Default Key Mappings Add the following line to your `.vimrc` to disable default key mappings. You can map them by yourself with `` mappings. @@@ -67,26 -71,15 +77,26 @@@ let g:vim_markdown_no_default_key_mappings=1 ``` -**Syntax extensions** +### Syntax extensions + +The following options control which syntax extensions will be turned on. They are off by default. -The following options control which syntax extensions will be turned on. +#### LaTeX math -LaTeX math: `$ $`, `$$ $$`, escapable as `\$ \$` and `\$\$ \$\$`: +Used as `$x^2$`, `$$x^2$$`, escapable as `\$x\$` and `\$\$x\$\$`. ```vim let g:vim_markdown_math=1 ``` + +#### YAML frontmatter + +Highlight YAML frontmatter as used by Jekyll: + +```vim +let g:vim_markdown_frontmatter=1 +``` + ## Mappings The following work on normal and visual modes: