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.
@@ -47,39+47,52 @@ tar --strip=1 -zxf vim-markdown-master.tar.gz
## Options
## Options
-**Disable Folding**
+### Disable Folding
-Add the following line to your `.vimrc` to disable folding.
+Add the following line to your `.vimrc` to disable the folding configuration:
```vim
let g:vim_markdown_folding_disabled=1
```
```vim
let g:vim_markdown_folding_disabled=1
```
-**Set Initial Foldlevel**
+This option only controls Vim Markdown specific folding configuration.
-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.
+To enable/disable folding use Vim's standard folding configuration.
```vim
```vim
-let g:vim_markdown_initial_foldlevel=1
+set [no]foldenable
```
```
-**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.
+Add the following line to your `.vimrc` to disable default key mappings:
```vim
let g:vim_markdown_no_default_key_mappings=1
```
```vim
let g:vim_markdown_no_default_key_mappings=1
```
-**Syntax extensions**
+You can also map them by yourself with `<Plug>` mappings.
-The following options control which syntax extensions will be turned on.
+### Syntax extensions
-LaTeX math: `$ $`, `$$ $$`, escapable as `\$ \$` and `\$\$ \$\$`:
+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
```
```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:
## Mappings
The following work on normal and visual modes:
@@ -93,7+106,7 @@ The following work on normal and visual modes:
## Commands
## Commands
-- `:HeaderDecrease`:
+- `:HeaderDecrease`:
Decrease level of all headers in buffer: `h2` to `h1`, `h3` to `h2`, etc.
Decrease level of all headers in buffer: `h2` to `h1`, `h3` to `h2`, etc.
@@ -103,30+116,30 @@ The following work on normal and visual modes:
For simplicity of implementation, Setex headers are converted to Atx.
For simplicity of implementation, Setex headers are converted to Atx.
-- `:HeaderIncrease`: Analogous to `:HeaderDecrease`, but increase levels instead.
+- `: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.
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-styleguide/#tables).
+- `:TableFormat`: Format the table under the cursor [like this](http://www.cirosantilli.com/markdown-styleguide/#tables).
projects / etc / vim.git / blobdiff