A few more cosmetic updates to README

This commit is contained in:
Scott Olsen
2020-04-16 17:30:31 -04:00
parent a88cfb6fc2
commit de0456245c

View File

@@ -1,27 +1,28 @@
# 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.
## Configuration
### Fenced Codeblock Highlighting
### 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']
**Note**: The fenced language names must be valid names of syntax files in vim's `syntax` folder. For example: `syntax/ruby.vim`.
**Note**: The fenced language names must be valid names of syntax files in vim's
`syntax` folder. For example: `syntax/ruby.vim`.
### Syntax Concealment
### Syntax concealment
To disable markdown syntax concealing, add the following to your `.vimrc`:
let g:markdown_syntax_conceal = 0
### Highlighting Synchronization
### Highlighting synchronization
Syntax highlighting is synchronized in 50 lines. This may cause collapsed
highlighting on large fenced code blocks.
@@ -29,7 +30,8 @@ In that case, set `g:markdown_minlines` to a larger value in your `.vimrc`:
let g:markdown_minlines = 100
**Note**: Setting `g:markdown_minlines` to a value that is too large value may cause poor highlighting performance.
**Note**: Setting `g:markdown_minlines` to a value that is too large value may
cause poor highlighting performance.
### Folding