Update doc

This commit is contained in:
leafOfTree
2021-04-26 16:03:04 +08:00
parent 9e642cc983
commit 32b89ad2bf

View File

@@ -19,6 +19,8 @@ What's New
## Installation ## Installation
You could install it just like other plugins. The filetype will be set to `vue`. Feel free to open an issue or pull request if any questions
<details> <details>
<summary><a>How to install</a></summary> <summary><a>How to install</a></summary>
@@ -52,19 +54,16 @@ What's New
set rtp+=path/to/this_plugin set rtp+=path/to/this_plugin
filetype plugin indent on filetype plugin indent on
``` ```
<br /> <br />
</details> </details>
The filetype will be set to `vue`. Feel free to open an issue or pull request if any questions
## How it works ## How it works
`vim-vue-plugin` will try to load multiple syntax and indent files for `.vue` and enable them to work together `vim-vue-plugin` will try to load multiple syntax and indent files for `.vue` and enable them to work together
- Blocks (both `template/script/style` and custom blocks) with any syntax, including `pug, typescript, coffee, scss, sass, less, stylus, ...` - Blocks (both `template/script/style` and custom blocks) with any syntax, including `pug, typescript, coffee, scss, sass, less, stylus, ...`
Relative syntax plugins need to be installed if not provided by vim Sntax plugins need to be installed if not provided by vim
- Attribute and keyword highlight - Attribute and keyword highlight
@@ -80,7 +79,7 @@ The filetype will be set to `vue`. Feel free to open an issue or pull request if
This is its **default value**. You could copy it as a starting point This is its **default value**. You could copy it as a starting point
```vim ```
let g:vim_vue_plugin_config = { let g:vim_vue_plugin_config = {
\'syntax': { \'syntax': {
\ 'template': ['html'], \ 'template': ['html'],
@@ -123,17 +122,11 @@ For boolean options, set `1` to enable or `0` to disable
- `debug`: echo debug messages in `messages` list - `debug`: echo debug messages in `messages` list
> Please check `:h dict` and `:h list` for details about the complex data types
>
> `typescript` matches `lang="ts"`
>
> For `.wpy`, `initial_indent` defaults to `['script', 'style']`
### Example ### Example
Only for demo. Try to set syntax as little as possible for performance Only for demo. Try to set syntax as little as possible for performance
```vim ```
let g:vim_vue_plugin_config = { let g:vim_vue_plugin_config = {
\'syntax': { \'syntax': {
\ 'template': ['html', 'pug'], \ 'template': ['html', 'pug'],
@@ -152,6 +145,14 @@ let g:vim_vue_plugin_config = {
\} \}
``` ```
Note
- `typescript` matches `lang="ts"`
- For `.wpy`, `initial_indent` defaults to `['script', 'style']`
- You could check `:h dict` and `:h list` for details about the complex data types
### Archive ### Archive
<details> <details>