Skip to content

Commit e74d758

Browse files
committed
Refactored README.md
* De-prioritized the not on regexes * Added vim-plug installation instructions * Improved header hierarchy * Improved configuration variables documentation * Removed some deprecated instructions * Tweaks misc content
1 parent c438302 commit e74d758

File tree

1 file changed

+39
-28
lines changed

1 file changed

+39
-28
lines changed

README.md

Lines changed: 39 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,68 +1,64 @@
11
# vim-javascript v0.10.0
22

3-
JavaScript bundle for vim, this bundle provides syntax and indent plugins.
3+
JavaScript bundle for vim, this bundle provides syntax highlighting and
4+
improved indentation.
45

5-
## A Quick Note on Regexes
66

7-
Vim 7.4 was released recently, and unfortunately broke how this plugin
8-
handles regexes. There was no real easy way for us to fix this unless we
9-
completely rewrote how regexes work.
7+
## Installation
108

11-
Good News: There was a recent update to Vim 7.4 that fixes this issue.
9+
### Install with [Vundle](https://github.com/gmarik/vundle)
1210

13-
Make sure you are at least using Vim 7.4, with patches 1-7.
11+
Add to vimrc:
1412

15-
If you are stuck on an older version of Vim 7.4 with no way to update,
16-
then simply perform the following commands to fix your current buffer:
13+
Plugin 'pangloss/vim-javascript'
1714

18-
```
19-
:set regexpengine=1
20-
:syntax enable
21-
```
15+
And install it:
2216

23-
## Installation
17+
:so ~/.vimrc
18+
:PluginInstall
2419

25-
### Install with [Vundle](https://github.com/gmarik/vundle)
20+
### Install with [vim-plug](https://github.com/junegunn/vim-plug)
2621

2722
Add to vimrc:
2823

29-
Plugin 'pangloss/vim-javascript'
24+
Plug 'pangloss/vim-javascript'
3025

3126
And install it:
3227

3328
:so ~/.vimrc
34-
:PluginInstall
29+
:PlugInstall
3530

3631
### Install with [pathogen](https://github.com/tpope/vim-pathogen)
3732

3833
cd ~/.vim/bundle
3934
git clone https://github.com/pangloss/vim-javascript.git
4035

41-
## Configuration
36+
37+
## Configuration Variables
4238

4339
The following variables control certain syntax highlighting features. You can
4440
add them to your `.vimrc` to enable/disable their features.
4541

46-
#### javascript_enable_domhtmlcss
42+
```
43+
let g:javascript_enable_domhtmlcss = 1
44+
```
4745

4846
Enables HTML/CSS syntax highlighting in your JavaScript file.
4947

5048
Default Value: 0
5149

52-
#### b:javascript_fold
50+
-----------------
5351

54-
Enables JavaScript code folding.
55-
56-
Default Value: 1
57-
58-
59-
#### javascript_ignore_javaScriptdoc
52+
```
53+
let g:javascript_ignore_javaScriptdoc = 1
54+
```
6055

6156
Disables JSDoc syntax highlighting
6257

6358
Default Value: 0
6459

65-
#### Concealing Characters
60+
61+
## Concealing Characters
6662

6763
You can customize concealing characters by defining one or more of the following
6864
variables:
@@ -78,6 +74,7 @@ variables:
7874
let g:javascript_conceal_super = "Ω"
7975
let g:javascript_conceal_arrow_function = "⇒"
8076

77+
8178
## Contributing
8279

8380
This project uses the [git
@@ -88,10 +85,24 @@ the price of admission is 1 pull request. Please follow the general code style
8885
guides (read the code) and in your pull request explain the reason for the
8986
proposed change and how it is valuable.
9087

91-
## Bug report
88+
89+
## Bug Reports
9290

9391
Report a bug on [GitHub Issues](https://github.com/pangloss/vim-javascript/issues).
9492

93+
94+
## A Quick Note on Regexes
95+
96+
Vim 7.4 with patches LESS than 1-7 exhibits a bug that broke how we handle
97+
javascript regexes. Please update to a newer version or run the following
98+
commands to fix:
99+
100+
```
101+
:set regexpengine=1
102+
:syntax enable
103+
```
104+
105+
95106
## License
96107

97108
Distributed under the same terms as Vim itself. See `:help license`.

0 commit comments

Comments
 (0)