From 6f6ff4c92267b39b27f05c93426a1776723c689c Mon Sep 17 00:00:00 2001 From: Scott Olsen Date: Mon, 22 Oct 2018 15:00:39 -0400 Subject: [PATCH 1/7] Add documentation on enabling folding. --- README.markdown | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.markdown b/README.markdown index 8c7c6d0..f7a2e5b 100644 --- a/README.markdown +++ b/README.markdown @@ -28,6 +28,10 @@ In the case, please set larger value in your vimrc: Note that setting too large value may cause bad performance on highlighting. +To enable folding, add the following to your vimrc: + + let g:markdown_folding = 1 + ## License Copyright © Tim Pope. Distributed under the same terms as Vim itself. From 4831a1241c6cd994ca94e1f2f034b58a278b29d8 Mon Sep 17 00:00:00 2001 From: Scott Olsen Date: Mon, 22 Oct 2018 15:04:09 -0400 Subject: [PATCH 2/7] Update the minlines section content; typos, grammar, etc. --- README.markdown | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.markdown b/README.markdown index f7a2e5b..5b2e7ba 100644 --- a/README.markdown +++ b/README.markdown @@ -20,13 +20,13 @@ 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: +Syntax highlight 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. To enable folding, add the following to your vimrc: From d7053febeb341f7e948c6b10b6b4ef6b318a17f4 Mon Sep 17 00:00:00 2001 From: Scott Olsen Date: Mon, 22 Oct 2018 15:09:43 -0400 Subject: [PATCH 3/7] Update the fenced codeblocks documentation. --- README.markdown | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.markdown b/README.markdown index 5b2e7ba..ea6bf08 100644 --- a/README.markdown +++ b/README.markdown @@ -11,11 +11,13 @@ installing from this repository, add the following to your vimrc: autocmd BufNewFile,BufReadPost *.md set filetype=markdown -If you want to enable fenced code block syntax highlighting in your markdown -documents you can enable it in your `.vimrc` like so: +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`. + To disable markdown syntax concealing add the following to your vimrc: let g:markdown_syntax_conceal = 0 From d6012fe996c477fe6b85a354cfcece5fd183163b Mon Sep 17 00:00:00 2001 From: Scott Olsen Date: Mon, 22 Oct 2018 15:16:45 -0400 Subject: [PATCH 4/7] Make vimrc mentions consistent. Fix minor typos. --- README.markdown | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.markdown b/README.markdown index ea6bf08..9bbc450 100644 --- a/README.markdown +++ b/README.markdown @@ -12,25 +12,25 @@ installing from this repository, add the following to your vimrc: autocmd BufNewFile,BufReadPost *.md set filetype=markdown To enable fenced code block syntax highlighting in your markdown -documents add the following to your vimrc: +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`. -To disable markdown syntax concealing add the following to your vimrc: +To disable markdown syntax concealing, add the following to your `.vimrc`: let g:markdown_syntax_conceal = 0 -Syntax highlight is synchronized in 50 lines. This may cause collapsed +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: +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. -To enable folding, add the following to your vimrc: +To enable folding, add the following to your `.vimrc`: let g:markdown_folding = 1 From c74710e89b1452e13a4b553b69cba1bb328af584 Mon Sep 17 00:00:00 2001 From: Scott Olsen Date: Mon, 22 Oct 2018 15:17:38 -0400 Subject: [PATCH 5/7] Add a configuration header. --- README.markdown | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.markdown b/README.markdown index 9bbc450..20b5cba 100644 --- a/README.markdown +++ b/README.markdown @@ -11,6 +11,8 @@ installing from this repository, add the following to your vimrc: autocmd BufNewFile,BufReadPost *.md set filetype=markdown +## Configuration + To enable fenced code block syntax highlighting in your markdown documents, add the following to your `.vimrc`: From 8946b2ecc18136f258061477ddf41516f72b129e Mon Sep 17 00:00:00 2001 From: Scott Olsen Date: Mon, 22 Oct 2018 15:23:08 -0400 Subject: [PATCH 6/7] Add section headers. --- README.markdown | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.markdown b/README.markdown index 20b5cba..129f64b 100644 --- a/README.markdown +++ b/README.markdown @@ -13,6 +13,8 @@ installing from this repository, add the following to your vimrc: ## Configuration +### Fenced Codeblock Highlighting + To enable fenced code block syntax highlighting in your markdown documents, add the following to your `.vimrc`: @@ -20,10 +22,14 @@ documents, 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 +### 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`: @@ -32,6 +38,8 @@ In that case, set `g:markdown_minlines` to a larger value in your `.vimrc`: **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 From de0456245ca72a565fcee741d9abf30427d4370d Mon Sep 17 00:00:00 2001 From: Scott Olsen Date: Thu, 16 Apr 2020 17:30:31 -0400 Subject: [PATCH 7/7] A few more cosmetic updates to README --- README.markdown | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.markdown b/README.markdown index dd92d07..46f731b 100644 --- a/README.markdown +++ b/README.markdown @@ -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