Skip to content

Commit 938f75f

Browse files
committed
update
1 parent a72ab52 commit 938f75f

File tree

12 files changed

+1485
-154
lines changed

12 files changed

+1485
-154
lines changed

.github/workflows/ci.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,12 @@ jobs:
2323
- name: panvimdoc
2424
uses: kdheepak/panvimdoc@main
2525
with:
26-
vimdoc: nvim-plugin-template.nvim
26+
vimdoc: fpkit.nvim
2727
treesitter: true
2828
- uses: stefanzweifel/git-auto-commit-action@v4
2929
with:
3030
commit_message: "chore(doc): auto generate docs"
3131
commit_user_name: "github-actions[bot]"
3232
commit_user_email: "github-actions[bot]@users.noreply.github.com"
3333
commit_author: "github-actions[bot] <github-actions[bot]@users.noreply.github.com>"
34+
y.github.com>"

README.md

Lines changed: 3 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,6 @@
1-
# nvim-plugin-template
1+
# FPKit.nvim
22

3-
Neovim plugin template; includes automatic documentation generation from README, integration tests with Busted, and linting with Stylua
4-
5-
## Usage
6-
7-
1. Click `use this template` button generate a repo on your github.
8-
2. Clone your plugin repo. Open terminal then cd plugin directory.
9-
3. Run `python3 rename.py your-plugin-name`. This will replace all `nvim-plugin-template` to your `plugin-name`.
10-
Then it will prompt you input `y` or `n` to remove example codes in `init.lua` and
11-
`test/plugin_spec.lua`. If you are familiar this repo just input `y`. If you are looking at this template for the first time I suggest you inspect the contents. After this step `rename.py` will also auto-remove.
12-
13-
Now you have a clean plugin environment. Enjoy!
14-
15-
## Format
16-
17-
The CI uses `stylua` to format the code; customize the formatting by editing `.stylua.toml`.
18-
19-
## Test
20-
21-
See [Running tests locally](https://github.com/nvim-neorocks/nvim-busted-action?tab=readme-ov-file#running-tests-locally)
22-
23-
## CI
24-
25-
- Auto generates doc from README.
26-
- Runs the [nvim-busted-action](https://github.com/nvim-neorocks/nvim-busted-action) for test.
27-
- Lints with `stylua`.
28-
29-
## More
30-
31-
To see this template in action, take a look at my other plugins.
3+
include the nvimdev/dired.nvim and nvimdev/fnpairs.nvim and more others in
4+
future
325

336
## License MIT

doc/nvim-plugin-template.nvim.txt

Lines changed: 0 additions & 60 deletions
This file was deleted.

0 commit comments

Comments
 (0)