Skip to content

Commit e65e4f0

Browse files
authored
Update and rename README.markdown to README.md
1 parent 2af4a1b commit e65e4f0

File tree

1 file changed

+13
-30
lines changed

1 file changed

+13
-30
lines changed
Lines changed: 13 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Enhanced JavaScript Syntax for Vim
22

3-
### Credits
3+
## Credits
44
- Zhao Yi, Claudio Fleiner, Scott Shattuck (This file is based on their hard work)
55
- gumnos (From the #vim IRC Channel in Freenode) (Who helped me figured out the
66
crazy Vim Regexes)
77

8-
### Description
8+
## Description
99
This file is a fork of [this file](http://www.vim.org/scripts/script.php?script_id=1491)
1010
and [the stock one](http://fleiner.com/vim/download.html)
1111

@@ -17,21 +17,26 @@ This version of this file features the following text highlights:
1717
- Operation, comparison and logical symbols (`=`,`==`,`===`,`!=`,etc.).
1818
- Separate highlight of the arguments. Thanks to [Billychan](https://github.com/jelera/vim-javascript-syntax/commit/b03f40ff6ddf605ac146634a651632d6c1e8a50b).
1919

20+
### Rationale
21+
While there are already a few syntax files in the wild (some even forks from this project), the goal is to have a syntax file that has current keywords for modern ES/JS development and to be fairly lean and quick on loading.
2022

21-
### [Screenshots](http://imgur.com/a/7bnu3)
23+
## Screenshots
2224
This is the stock Javascript syntax file
2325
#### Solarized Light
2426
![Stock Vim JavaScript syntax file](http://i.imgur.com/FCVLMgl.png)
2527

2628
This is with the Enhanced Syntax file
2729
![Enhanced JavaScript Vim syntax](http://i.imgur.com/yGY3Cmm.png)
2830

31+
More screenshots [here](http://imgur.com/a/7bnu3).
32+
2933
#### Hybrid
3034
![Stock Vim JavaScript syntax file](http://i.imgur.com/cGb3EjH.png)
3135

3236
This is with the Enhanced Syntax file
3337
![Enhanced JavaScript Vim syntax](http://i.imgur.com/cmgdlO6.png)
34-
### Installation
38+
39+
## Installation
3540
- Using [Vim-Plug](https://github.com/junegunn/vim-plug) **(Which I recommend)**,
3641
add this line to your `.vimrc`
3742

@@ -53,7 +58,7 @@ Plugin 'jelera/vim-javascript-syntax'
5358
git clone https://github.com/jelera/vim-javascript-syntax.git ~/.vim/bundle/vim-javascript-syntax
5459
```
5560

56-
### Suggested Companion Plugins
61+
## Suggested Companion Plugins
5762
- **Indentation**
5863
The recommended way is to use [Prettier](https://prettier.io/docs/en/vim.html) and [ALE](https://github.com/dense-analysis/ale).
5964

@@ -64,31 +69,9 @@ The project is unmaintained for now, but you could fork it and improve upon it.~
6469
- [Tern for Vim](https://github.com/marijnh/tern_for_vim)
6570
- Popular **third-party libraries support** like jQuery, YUI, Prototype, by [javascript-libraries-syntax](https://github.com/othree/javascript-libraries-syntax.vim)
6671

67-
68-
### Contributions
69-
This project follows the
70-
[Git-flow](http://nvie.com/posts/a-successful-git-branching-model/) methodology,
71-
this will keep the master branch clean for new stable releases. Also the
72-
version numbering convention will be [this one](http://stackoverflow.com/a/65750)
73-
74-
More about Git-flow at:
75-
- [Daniel Kummer's Git Flow cheatsheet](http://danielkummer.github.io/git-flow-cheatsheet/)
76-
- [Sayanee Basu's Build Podcast - Git Flow](https://www.youtube.com/watch?v=Hh-jJcJ5IJ8)
77-
78-
#### For new contributors
79-
Follow this steps
80-
- Clone this repository.
81-
- Using the command line, run `git flow init -d`.
82-
- Checkout the `develop` branch.
83-
- For new features: Create a new `feature` branch using git-flow.
84-
- For bugfixes: Commit in the `develop` branch.
85-
- Bump the date and version number on the syntax file.
86-
- When done, don't forget to push the `develop` branch.
87-
- Submit a pull request.
88-
72+
## Contributions
8973
While all contributions are always welcome, make sure your commit message follow this
90-
[**convention**](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
91-
74+
[**convention**](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
9275

93-
### License
76+
## License
9477
The same as Vim

0 commit comments

Comments
 (0)