Skip to content

Commit bbe478f

Browse files
author
othree_kao
committed
Update readme
1 parent 8aabdfd commit bbe478f

1 file changed

Lines changed: 53 additions & 42 deletions

File tree

README.md

Lines changed: 53 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,55 @@
1-
# javascript-libraries-syntax.vim
1+
javascript-libraries-syntax.vim
2+
===============================
23

34
Syntax file for JavaScript libraries. Supports JavaScript libraris I am using (patches welcome).
45
Should works well with other JavaScript syntax file. [SyntaxComplete][] also works well on all
56
supported languages.
67

7-
## Libraries
8+
[SyntaxComplete]:http://www.vim.org/scripts/script.php?script_id=3172
9+
10+
Libraries
11+
---------
812

9-
- [jQuery](http://jquery.com/)
10-
- [underscore.js](http://underscorejs.org/)
11-
- [Backbone.js](http://backbonejs.org/)
12-
- [prelude.ls](http://gkz.github.com/prelude-ls/)
13-
- [AngularJS](http://angularjs.org/)
14-
- [RequireJS](http://requirejs.org/)
13+
* [jQuery](http://jquery.com/)
14+
* [underscore.js](http://underscorejs.org/)
15+
* [Backbone.js](http://backbonejs.org/)
16+
* [prelude.ls](http://gkz.github.com/prelude-ls/)
17+
* [AngularJS](http://angularjs.org/)
18+
* [RequireJS](http://requirejs.org/)
1519

16-
## File Types
20+
File Types
21+
----------
1722

18-
- JavaScript
19-
- [CoffeeScript](http://coffeescript.org/)
20-
- [LiveScript](http://livescript.net/)
21-
- [TypeScript](http://www.typescriptlang.org/)
23+
* JavaScript
24+
* [CoffeeScript](http://coffeescript.org/)
25+
* [LiveScript](http://livescript.net/)
26+
* [TypeScript](http://www.typescriptlang.org/)
2227

2328
Will be more when SyntaxComplete has new version.
2429

25-
## Install
30+
Install
31+
-------
32+
33+
Use [pathogen][] or [vundle][] is recommended.
2634

27-
Use [pathogen][] or [vundle][].
35+
[pathogen]:http://www.vim.org/scripts/script.php?script_id=2332
36+
[vundle]:https://github.com/gmarik/vundle
2837

29-
## Config
38+
Config
39+
------
3040

3141
You can use g:used_javascript_libs to setup used libraries, ex:
3242

3343
let g:used_javascript_libs = 'underscore,backbone'
3444

3545
Support libs id:
3646

37-
- jQuery: jquery
38-
- underscore.js: underscore
39-
- Backbone.js: backbone
40-
- prelude.ls: prelude
41-
- AngularJS: angularjs
42-
- RequireJS: requirejs
47+
* jQuery: jquery
48+
* underscore.js: underscore
49+
* Backbone.js: backbone
50+
* prelude.ls: prelude
51+
* AngularJS: angularjs
52+
* RequireJS: requirejs
4353

4454
You can use [local vimrc][] to setup libraries used in project. Sample code for local vimrc:
4555

@@ -51,11 +61,13 @@ You can use [local vimrc][] to setup libraries used in project. Sample code for
5161

5262
[local vimrc]:https://github.com/MarcWeber/vim-addon-local-vimrc
5363

54-
## Todo
64+
Todo
65+
----
5566

56-
- Support future version of SyntaxComplete
67+
* Support future version of SyntaxComplete
5768

58-
## Known Issue
69+
Known Issue
70+
-----------
5971

6072
SyntaxComplete only accept groups with filetype prefixed. For example, 'javascript' files.
6173
Only keywords in groups which's name matches /javascript.*/ will be available. So to make it
@@ -64,35 +76,36 @@ languages. We must redefine all syntax many times, with different name prefix. S
6476
might have new feature to support a user define pattern for group name to include.
6577
All repeat defination will be removed when SyntaxComplete supports this feature.
6678

67-
## Changes
79+
Changes
80+
-------
6881

6982
### Version 0.3.1
70-
71-
- Fix performance issue
83+
* Fix performance issue
7284

7385
### Version 0.3
74-
75-
- Supports AngularJS, RequireJS
76-
- Support TypeScript
77-
- Setup used libraries
78-
- Better init way
86+
* Supports AngularJS, RequireJS
87+
* Support TypeScript
88+
* Setup used libraries
89+
* Better init way
7990

8091
### Version 0.2
81-
- Supports library selection
92+
* Supports library selection
8293

8394
### Version 0.1
84-
- First release.
95+
* First release.
8596

86-
## Credits
97+
Credits
98+
-------
8799

88-
- Bruno Michel, [jQuery : Syntax file for jQuery][jquery.vim]
89-
- [Peter Renström][], for [summarize and explain AngularJS stuff][issue1].
100+
* Bruno Michel, [jQuery : Syntax file for jQuery][jquery.vim]
101+
* [Peter Renström][], for [summarize and explain AngularJS stuff][issue1].
90102

91103
[jquery.vim]:http://www.vim.org/scripts/script.php?script_id=2416
92104
[Peter Renström]:https://github.com/renstrom
93105
[issue1]:https://github.com/othree/javascript-libraries-syntax.vim/issues/1
94106

95-
## License
107+
License
108+
-------
96109

97110
Copyright (c) 2013 Wei-Ko Kao
98111

@@ -114,6 +127,4 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
114127
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
115128
THE SOFTWARE.
116129

117-
[SyntaxComplete]:http://www.vim.org/scripts/script.php?script_id=3172
118-
[pathogen]:http://www.vim.org/scripts/script.php?script_id=2332
119-
[vundle]:https://github.com/gmarik/vundle
130+

0 commit comments

Comments
 (0)