Skip to content

Commit 1cf9c7c

Browse files
wsdjegwsdjeg
committed
docs(readme): update readme
1 parent 95032b5 commit 1cf9c7c

1 file changed

Lines changed: 23 additions & 24 deletions

File tree

‎README.md‎

Lines changed: 23 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -172,28 +172,28 @@ require('plug').add({
172172

173173
The plugin spec is inspired by [dein.nvim](https://github.com/Shougo/dein.vim).
174174

175-
| name | description |
176-
| --------------- | ---------------------------------------------------------------------------------------------------------------- |
177-
| `[1]` | `string`, plugin repo short name, `wsdjeg/flygrep.nvim` |
178-
| `cmds` | `string` or `table<string>`, commands lazy loading |
179-
| `events` | `string` or `table<string>`, events lazy loading |
180-
| `config` | `function`, function called after adding plugin path to nvim rtp, before loading files in `plugin/` directory |
181-
| `config_after` | `function`, function called after loading files in `plugin/` directory |
182-
| `config_before` | `function`, function called when `plug.add()` function is called |
183-
| `on_ft` | `string` or `table<string>`, filetypes lazy loading |
184-
| `on_map` | `string` or `table<string>`, key bindings lazy loading |
185-
| `on_func` | `string` or `table<string>`, vim function lazy loading |
186-
| `script_type` | `string`, plugin type including `color`, `plugin`, etc.. |
187-
| `build` | `string` or `table<string>`, executed by [job](https://spacevim.org/api/job/) api |
188-
| `enabled` | `boolean` or `function` evaluated when startup, when it is false, plugin will be skiped |
189-
| `frozen` | update only when specific with `PlugUpdate name` |
190-
| `depends` | `table<PluginSpec>` a list of plugins |
191-
| `branch` | `string` specific git branch |
192-
| `tag` | `string` specific git tag |
193-
| `type` | `string` specific plugin type, this can be git, raw or none, if it is raw, `script_type` must be set |
194-
| `autoload` | `boolean`, load plugin after git clone |
195-
| `priority` | `number`, default is 50, set the order in which plugins are loaded |
196-
| `fetch` | If set to true, nvim-plug doesn't add the path to user runtimepath. It is useful to manager no-plugin repository |
175+
| name | description |
176+
| --------------- | --------------------------------------------------------------------------------------------------------------------------- |
177+
| `[1]` | `string`, plugin repo short name, `wsdjeg/flygrep.nvim` |
178+
| `cmds` | `string`, or `table<string>`, commands lazy loading |
179+
| `events` | `string`, or `table<string>`, events lazy loading |
180+
| `config` | `function`, function called after adding plugin path to nvim rtp, before loading files in `plugin/` directory |
181+
| `config_after` | `function`, function called after loading files in `plugin/` directory |
182+
| `config_before` | `function`, function called when `plug.add()` function is called |
183+
| `on_ft` | `string`, or `table<string>`, filetypes lazy loading |
184+
| `on_map` | `string`, or `table<string>`, key bindings lazy loading |
185+
| `on_func` | `string`, or `table<string>`, vim function lazy loading |
186+
| `script_type` | `string`, plugin type including `color`, `plugin`, etc.. |
187+
| `build` | `string`, or `table<string>`, executed by [job](https://spacevim.org/api/job/) api |
188+
| `enabled` | `boolean`, or `function` evaluated when startup, when it is false, plugin will be skiped |
189+
| `frozen` | `booleadn`, update only when specific with `PlugUpdate name` |
190+
| `depends` | `table<PluginSpec>`, a list of plugins |
191+
| `branch` | `string`, specific git branch |
192+
| `tag` | `string`, specific git tag |
193+
| `type` | `string`, specific plugin type, this can be git, raw or none, if it is raw, `script_type` must be set |
194+
| `autoload` | `boolean`, load plugin after git clone |
195+
| `priority` | `number`, default is 50, set the order in which plugins are loaded |
196+
| `fetch` | `boolean`, If set to true, nvim-plug doesn't add the path to user runtimepath. It is useful to manager no-plugin repository |
197197

198198
- `config` and `config_after` function will be not be called if the plugin has not been installed.
199199
- `priority` does not work for lazy plugins.
@@ -376,8 +376,7 @@ Like this plugin? Star the repository on
376376
GitHub.
377377

378378
Love this plugin? Follow [me](https://wsdjeg.net/) on
379-
[GitHub](https://github.com/wsdjeg) and
380-
[Twitter](http://twitter.com/wsdtty).
379+
[GitHub](https://github.com/wsdjeg).
381380

382381
## Feedback
383382

0 commit comments

Comments
 (0)