diff --git a/README.md b/README.md index 313c3a1..e51f19a 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,28 @@ # vim-vue-plugin -Vim syntax and indent plugin for `.vue` files. Mainly inspired by [mxw/vim-jsx][1]. +Vim syntax and indent plugin for `.vue` files. Mainly inspired by [mxw/vim-jsx][1]. + +[![Build Status][12]](https://travis-ci.com/leafOfTree/test) ## Install -- Use [VundleVim][2] +- [VundleVim][2] Plugin 'leafOfTree/vim-vue-plugin' -- Use [vim-pathogen][5] +- [vim-pathogen][5] cd ~/.vim/bundle && \ git clone https://github.com/leafOfTree/vim-vue-plugin --depth 1 -- Use [vim-plug][7] +- [vim-plug][7] Plug 'leafOfTree/vim-vue-plugin' :PlugInstall -- Or manually, clone this plugin, drop it in custom `path/to/this_plugin`, and add it to `rtp` in vimrc +- Or manually, clone this plugin to `path/to/this_plugin`, and add it to `rtp` in vimrc - set rpt+=path/to/this_plugin + set rtp+=path/to/this_plugin The plugin works if `filetype` is set to `vue`. Please stay up to date. Feel free to open an issue or a pull request. @@ -32,18 +34,18 @@ Since `.vue` is a combination of CSS, HTML and JavaScript, so is `vim-vue-plugin Supports - Vue directives. -- Pug with [vim-pug][4] (see Configuration). -- Less/Sass/Scss (see Configuration). -- Coffee with [vim-coffee-script][11] (see Configuration). -- A builtin `foldexpr` foldmethod (see Configuration). +- Pug with [vim-pug][4].^ +- Less/Sass/Scss.^ +- Coffee with [vim-coffee-script][11].^ +- A builtin `foldexpr` foldmethod.^ - [emmet-vim][10] HTML/CSS/JavaScript filetype detection. - `.wpy` files from [WePY][6]. +^: see Configuration for details. + ## Configuration -Set global variable to `1` to enable or `0` to disable. - -Ex: +Set global variable to `1` to enable or `0` to disable. Ex: let g:vim_vue_plugin_load_full_syntax = 1 @@ -53,7 +55,7 @@ Ex: | `g:vim_vue_plugin_use_pug`\* | Enable `vim-pug` pug syntax for `