https://github.com/2KAbhishek/template.nvim
Ready to go Neovim template 🏗️✈️
https://github.com/2KAbhishek/template.nvim
community neovim neovim-plugin plugin template terminal vim
Last synced: 7 days ago
JSON representation
Ready to go Neovim template 🏗️✈️
- Host: GitHub
- URL: https://github.com/2KAbhishek/template.nvim
- Owner: 2KAbhishek
- License: gpl-3.0
- Created: 2024-09-15T00:49:34.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-02-23T13:29:25.000Z (about 2 months ago)
- Last Synced: 2025-04-06T03:28:47.937Z (13 days ago)
- Topics: community, neovim, neovim-plugin, plugin, template, terminal, vim
- Language: Lua
- Homepage:
- Size: 54.7 KB
- Stars: 11
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-neovim-sorted - 2KAbhishek/template.nvim
- awesome-neovim-sorted - 2KAbhishek/template.nvim
README
template.nvim is a neovim plugin that allows neovim users to ``.
## ✨ Features
- Includes a ready to go neovim plugin template
- Comes with a lint and test CI action
- Includes a Github action to auto generate vimdocs
- Comes with a ready to go README template
- Works with [mkrepo](https://github.com/2kabhishek/mkrepo)
## ⚡ Setup
### ⚙️ Requirements
- Latest version of `neovim`
### 💻 Installation
```lua
-- Lazy
{
'2kabhishek/template.nvim',
cmd = 'TemplateHello',
-- Add your custom configs here, keep it blank for default configs (required)
opts = {},
-- Use this for local development
-- dir = '~/path-to/template.nvim',
},
```
## 🚀 Usage
1. Fork the `template.nvim` repo
2. Update the plugin name, file names etc, change `template` to `your-plugin-name`
3. Add the code required for your plugin,
- Code entrypoint is [template.lua](./lua/template.lua)
- Add user configs to [config.lua](./lua/template/config.lua)
- For adding commands and keybindngs use [commands.lua](./lua/template/commands.lua)
- Separate plugin logic into modules under [modules](./lua/template/) dir
4. Add test code to the [tests](./tests/) directory
5. Update the README
6. Tweak the [docs action](./.github/workflows/docs.yml) file to reflect your plugin name, commit email and username
- Generating vimdocs needs read and write access to actions (repo settings > actions > general > workflow permissions)
### Configuration
template.nvim can be configured using the following options:
```lua
template.setup({
name = 'template.nvim', -- Name to be greeted, 'World' by default
})
```
### Commands
`template.nvim` adds the following commands:
- `TemplateHello`: Shows a hello message with the confugred name.
### Keybindings
It is recommended to use:
- `th,` for `TemplateHello`
> NOTE: By default there are no configured keybindings.
### Help
Run `:help template.txt` for more details.
## 🏗️ What's Next
Planning to add ``.
### ✅ To-Do
- [x] Setup repo
- [ ] Think real hard
- [ ] Start typing
## ⛅ Behind The Code
### 🌈 Inspiration
template.nvim was inspired by [nvim-plugin-template](https://github.com/ellisonleao/nvim-plugin-template), I added some changes on top to make setting up a new plugin faster.
### 💡 Challenges/Learnings
- The main challenges were ``
- I learned about ``
### 🧰 Tooling
- [dots2k](https://github.com/2kabhishek/dots2k) — Dev Environment
- [nvim2k](https://github.com/2kabhishek/nvim2k) — Personalized Editor
- [sway2k](https://github.com/2kabhishek/sway2k) — Desktop Environment
- [qute2k](https://github.com/2kabhishek/qute2k) — Personalized Browser
### 🔍 More Info
- [nerdy.nvim](https://github.com/2kabhishek/nerdy.nvim) — Find nerd glyphs easily
- [tdo.nvim](https://github.com/2KAbhishek/tdo.nvim) — Fast and simple notes in Neovim
- [termim.nvim](https://github.com/2kabhishek/termim.nvim) — Neovim terminal improved
- [octohub.nvim](https://github.com/2kabhishek/octohub.nvim) — Github repos in Neovim
- [exercism.nvim](https://github.com/2kabhishek/exercism.nvim) — Exercism exercises in Neovim
⭐ hit the star button if you found this useful ⭐
Source
| Blog
| Twitter
| LinkedIn
| More Links
| Other Projects
