chore(doc): auto generate docs
This commit is contained in:
parent
bfa7836cdb
commit
aeb066f1f4
|
|
@ -5,6 +5,7 @@ Table of Contents *nvim-plugin-template-table-of-contents*
|
|||
|
||||
1. nvim-plugin-template |nvim-plugin-template-nvim-plugin-template|
|
||||
- Usage |nvim-plugin-template-nvim-plugin-template-usage|
|
||||
- Format |nvim-plugin-template-nvim-plugin-template-format|
|
||||
- Test |nvim-plugin-template-nvim-plugin-template-test|
|
||||
- Ci |nvim-plugin-template-nvim-plugin-template-ci|
|
||||
- More |nvim-plugin-template-nvim-plugin-template-more|
|
||||
|
|
@ -24,6 +25,11 @@ rename.py your-plugin-name` this will replace all `nvim-plugin-template` to
|
|||
your `pluing-name`. Then develope your plugin. Enjoy!
|
||||
|
||||
|
||||
FORMAT *nvim-plugin-template-nvim-plugin-template-format*
|
||||
|
||||
format use `stylua` and provide `.stylua.toml`.
|
||||
|
||||
|
||||
TEST *nvim-plugin-template-nvim-plugin-template-test*
|
||||
|
||||
use vusted for test install by using `luarocks --lua-version=5.1 install
|
||||
|
|
@ -35,7 +41,8 @@ usage please check busted usage <https://lunarmodules.github.io/busted/>
|
|||
|
||||
CI *nvim-plugin-template-nvim-plugin-template-ci*
|
||||
|
||||
Ci support auto generate doc from README and integration test.
|
||||
Ci support auto generate doc from README and integration test and lint check by
|
||||
`stylua`.
|
||||
|
||||
|
||||
MORE *nvim-plugin-template-nvim-plugin-template-more*
|
||||
|
|
|
|||
Loading…
Reference in New Issue