VimPlug/vim-vue-plugin
1
0
Fork 0
mirror of https://github.com/leafOfTree/vim-vue-plugin.git synced 2025-12-07 13:14:34 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update doc

Browse Source
This commit is contained in:
leafOfTree
2021-03-29 18:43:52 +08:00
parent 950b6dc126
commit 5aee4f5a0d
1 changed files with 23 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@@ -67,14 +67,12 @@ see [Configuration](#configuration) for details
## Configuration ## Configuration
`g:vim_vue_plugin_config` is the only configuration variable `g:vim_vue_plugin_config`*dict* is the only configuration
- type: `dict` This is the **default value**. You could copy it as a starting point
- default:
You could copy the default value as a starting point ```vim
```vim let g:vim_vue_plugin_config = {
let g:vim_vue_plugin_config = {
\'syntax': { \'syntax': {
\ 'script': ['javascript'], \ 'script': ['javascript'],
\ 'template': ['html'], \ 'template': ['html'],
@@ -87,11 +85,13 @@ see [Configuration](#configuration) for details
\'init_indent': 0, \'init_indent': 0,
\'debug': 0, \'debug': 0,
\} \}
``` ```
### Description ### Description
- `syntax`*dict* A dictionary with the following key-value pairs `g:vim_vue_plugin_config` has following options
- `syntax`*dict* A dictionary with following key-value pairs
- `key`*string*: a block's tag name - `key`*string*: a block's tag name
- `value`*list*: a list of syntax name for the block - `value`*list*: a list of syntax name for the block
@@ -102,6 +102,8 @@ see [Configuration](#configuration) for details
- `full_syntax`*list*: a list of syntax name whose **full** syntax files are always loaded - `full_syntax`*list*: a list of syntax name whose **full** syntax files are always loaded
For boolean options, set `0` to enable or `1` to disable
- `attribute`: highlight Vue attribute as expression instead of string - `attribute`: highlight Vue attribute as expression instead of string
- `keyword`: highlight Vue keyword such as `data`, `methods`, ... - `keyword`: highlight Vue keyword such as `data`, `methods`, ...
@@ -112,9 +114,7 @@ see [Configuration](#configuration) for details
- `debug`: echo debug messages in `messages` list - `debug`: echo debug messages in `messages` list
> For boolean option, set `0` to enable or `1` to disable > Please check `:h dict` and `:h list` for details about the complex data types
>
> Please check `:h dict` `:h list` for details about the complex data types
### Example ### Example
One possible usage One possible usage