Skip to content

Commit aeeca84

Browse files
committed
Update README as AsciiDoc and with a demo GIF
1 parent 41b8cec commit aeeca84

File tree

3 files changed

+22
-8
lines changed

3 files changed

+22
-8
lines changed

README

Lines changed: 0 additions & 8 deletions
This file was deleted.

README.adoc

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
== vim-context-commentstring
2+
3+
This is a very simple plugin to automatically set the 'commentstring' and
4+
'comments' Vim options in file types which contain more than one syntax (like
5+
JavaScript nested inside HTML, or Lua nested in VimL).
6+
7+
It uses the names of the syntax highlighting groups to know where the cursor is,
8+
and just set the value of those Vim settings to one appropriate for that part of
9+
the file.
10+
11+
This will make Vim properly use the features, which by default are just fixed
12+
values which are set by file type. This allows to use a plugin like
13+
https://github.com/tpope/vim-commentary[Tim Pope's vim-commentary] to toggle the
14+
comments, or the native Vim functionality of wrapping text when you are typing
15+
a lines of comments.
16+
17+
image::demo1.gif[Demo]
18+
19+
See the documentation in the doc/context-commentstring.txt file, or browse it
20+
online from the hosted source code in:
21+
22+
https://raw.github.com/suy/vim-context-commentstring/master/doc/context-commentstring.txt

demo1.gif

1.03 MB
Loading

0 commit comments

Comments
 (0)