Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme update #135

Open
wants to merge 9 commits into
base: master
Choose a base branch
from
34 changes: 26 additions & 8 deletions README.markdown
Original file line number Diff line number Diff line change
@@ -1,25 +1,43 @@
# Vim Markdown runtime files

This is the development version of Vim's included syntax highlighting and
filetype plugins for Markdown. Generally you don't need to install these if
filetype plugins for Markdown. Generally you don't need to install these if
you are running a recent version of Vim.

If you want to enable fenced code block syntax highlighting in your markdown
documents you can enable it in your `.vimrc` like so:
## Configuration

### Fenced code block highlighting

To enable fenced code block syntax highlighting in your markdown
documents, add the following to your `.vimrc`:

let g:markdown_fenced_languages = ['html', 'python', 'bash=sh']

To disable markdown syntax concealing add the following to your vimrc:
**Note**: The fenced language names must be valid names of syntax files in vim's
`syntax` folder. For example: `syntax/ruby.vim`.

### Syntax concealment

To disable markdown syntax concealing, add the following to your `.vimrc`:

let g:markdown_syntax_conceal = 0

Syntax highlight is synchronized in 50 lines. It may cause collapsed
highlighting at large fenced code block.
In the case, please set larger value in your vimrc:
### Highlighting synchronization

Syntax highlighting is synchronized in 50 lines. This may cause collapsed
highlighting on large fenced code blocks.
In that case, set `g:markdown_minlines` to a larger value in your `.vimrc`:

let g:markdown_minlines = 100

Note that setting too large value may cause bad performance on highlighting.
**Note**: Setting `g:markdown_minlines` to a value that is too large value may
cause poor highlighting performance.

### Folding

To enable folding, add the following to your `.vimrc`:

let g:markdown_folding = 1

## License

Expand Down