From d6b3d6b9f3f8fdee03ec74e0682505555fae0071 Mon Sep 17 00:00:00 2001 From: Jose Elera Date: Sun, 8 Dec 2013 18:40:58 -0600 Subject: [PATCH] Update README New screenshots, add extra info about other plugins and contributions --- README.markdown | 73 ++++++++++++++++++++++++++++++------------------- 1 file changed, 45 insertions(+), 28 deletions(-) diff --git a/README.markdown b/README.markdown index 54fb543..8ffdb8c 100644 --- a/README.markdown +++ b/README.markdown @@ -1,11 +1,13 @@ -#Enhanced Javascript Syntax for Vim +# Enhanced JavaScript Syntax for Vim -###Credits +### Credits - Zhao Yi, Claudio Fleiner, Scott Shattuck (This file is based on their hard work) -- gumnos (From the #vim IRC Channel in Freenode) (Who helped me figured out the crazy Vim Regexes) +- gumnos (From the #vim IRC Channel in Freenode) (Who helped me figured out the + crazy Vim Regexes) -###Description -This file is a fork of [this file](http://www.vim.org/scripts/script.php?script_id=1491) and [the stock one](http://fleiner.com/vim/download.html) +### Description +This file is a fork of [this file](http://www.vim.org/scripts/script.php?script_id=1491) +and [the stock one](http://fleiner.com/vim/download.html) This version of this file features the following text highlights: @@ -13,42 +15,57 @@ This version of this file features the following text highlights: - The semicolon or comma at the end of line. - Browser, DOM and "Ajax" keywords like objects, methods, properties and others. - Operation, comparison and logical symbols (`=`,`==`,`===`,`!=`,etc.). +- Separate highlight of the arguments. Thanks to [Billychan](https://github.com/jelera/vim-javascript-syntax/commit/b03f40ff6ddf605ac146634a651632d6c1e8a50b). To enable code folding add the following to your `.vimrc`. - au FileType javascript call JavaScriptFold() +```vim +au FileType javascript call JavaScriptFold() +``` -###Note -This is a syntax plugin, not an indentation one. For indentation, this is the [recommended one](https://github.com/vim-scripts/JavaScript-Indent) by Preston Koprivica. +### Installation +- Using [NeoBundle](https://github.com/Shougo/neobundle.vim) **(Which I recommend)**, + add this line to your `.vimrc` -###Installation -- Using [NeoBundle](https://github.com/Shougo/neobundle.vim) **(Which I recommend)** +```vim +NeoBundleLazy 'jelera/vim-javascript-syntax', {'autoload':{'filetypes':['javascript']}} +``` - NeoBundleLazy 'jelera/vim-javascript-syntax', {'autoload':{'filetypes':['javascript']}} +- Using [Vundle](https://github.com/gmarik/vundle), + add this line to your `.vimrc` -- Using [Vundle](https://github.com/gmarik/vundle) +```vim +Bundle 'jelera/vim-javascript-syntax' +``` - Bundle 'jelera/vim-javascript-syntax' +- Using [Pathogen](https://github.com/tpope/vim-pathogen), + run this command in your shell -- Using [Pathogen](https://github.com/tpope/vim-pathogen) +```bash +git clone https://github.com/jelera/vim-javascript-syntax.git ~/.vim/bundle/vim-javascript-syntax +``` +### Suggested Companion Plugins +- Indentation, can be achieved with [Javascript-Indent](https://github.com/vim-scripts/JavaScript-Indent) by Preston Koprivica. +- Autocompletion by [Tern for Vim](https://github.com/marijnh/tern_for_vim) +- Popular third-party libraries like jQuery, YUI, Prototype, by [javascript-libraries-syntax](https://github.com/othree/javascript-libraries-syntax.vim) - $ cd ~/.vim/bundle - $ git clone https://github.com/jelera/vim-javascript-syntax.git - +### Contributions +Always welcome, make sure your commit message should follow this +[**convention**](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) -###TODO -You can help me improve it too. - -- ~~The separate highlight of the arguments~~ Thanks to [Billychan](https://github.com/jelera/vim-javascript-syntax/commit/b03f40ff6ddf605ac146634a651632d6c1e8a50b) for this -- ~~I know this is a syntax file, but having an autocompletion file.~~ So far a better autocompletion can be achieved by [Tern for Vim](https://github.com/marijnh/tern_for_vim) -- ~~Add keywords for the popular third-party libraries like jQuery, YUI, Prototype, etc.~~ This can be done with [this repo](https://github.com/othree/javascript-libraries-syntax.vim) - -###Screenshots +### [Screenshots](http://imgur.com/a/7bnu3) This is the stock Javascript syntax file -![Stock Vim Javascript syntax file](http://i.imgur.com/bfQD7.png) +#### Solarized Light +![Stock Vim JavaScript syntax file](http://i.imgur.com/FCVLMgl.png) This is with the Enhanced Syntax file -![Enhanced Javascript Vim syntax](http://i.imgur.com/Tezu3.png) +![Enhanced JavaScript Vim syntax](http://i.imgur.com/yGY3Cmm.png) -###License +#### Hybrid +![Stock Vim JavaScript syntax file](http://i.imgur.com/cGb3EjH.png) + +This is with the Enhanced Syntax file +![Enhanced JavaScript Vim syntax](http://i.imgur.com/cmgdlO6.png) + +### License The same as Vim