]> git.madduck.net Git - etc/vim.git/commitdiff

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:

Merge pull request #134 from cirosantilli/readme-uniform-codeblocks
authorCiro Santilli <ciro.santilli@gmail.com>
Mon, 6 Oct 2014 10:02:20 +0000 (12:02 +0200)
committerCiro Santilli <ciro.santilli@gmail.com>
Mon, 6 Oct 2014 10:02:20 +0000 (12:02 +0200)
Use a single code block style on README.

1  2 
README.md

diff --combined README.md
index 9583a4385b1e4ada0e140c26f6e3e3d239f303d6,93b0d98607cb0a1a7cef33c1988b4cc7198de575..419c26d8c285089844cbaff053fc514f21a46ec8
+++ 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 `<Plug>` mappings.
  
  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: