Update doc

This commit is contained in:
leafOfTree
2019-10-12 16:00:05 +08:00
parent c4ec224820
commit 44ab99e97b

View File

@@ -8,9 +8,11 @@
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].
## Install ## Install
<details>
<summary><a>How to install</a></summary>
- [VundleVim][2] - [VundleVim][2]
Plugin 'leafOfTree/vim-vue-plugin' Plugin 'leafOfTree/vim-vue-plugin'
@@ -29,8 +31,10 @@ Vim syntax and indent plugin for `.vue` files. Mainly inspired by [mxw/vim-jsx][
set rtp+=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. <br />
</details>
This plugin works if `filetype` is set to `vue`. Please stay up to date. Feel free to open an issue or a pull request.
## How it works ## How it works
@@ -68,7 +72,7 @@ Set global variable to `1` to enable or `0` to disable. Ex:
**Note** **Note**
- `filetype` used to be set to `javascript.vue`, which caused `javascript` syntax to be loaded multiple times and a significant delay. Now it is `vue` so autocmds and other settings for `javascript` have to be manually enabled for `vue`. - `filetype` is set to `vue` so autocmds and other custom settings for `javascript` have to be manually enabled for `vue`.
- `g:vim_vue_plugin_use_foldexpr` default value used to be `1`. But there are other foldmethod choices, so it's changed to `0`. - `g:vim_vue_plugin_use_foldexpr` default value used to be `1`. But there are other foldmethod choices, so it's changed to `0`.
## Context based behavior ## Context based behavior