neovimcraft

plugins configs about

externalboilerplate

CREATED

2024-09-15

UPDATED

2 days ago

template.nvim is a neovim plugin that allows neovim users to <action>.

✨ 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

⚡ Setup

⚙️ Requirements

Latest version of neovim

💻 Installation

-- Lazy
{
    '2kabhishek/template.nvim',
    dependencies = {
        'nvim-lua/plenary.nvim'
    },
    cmd = 'TemplateHello',
},

-- Packer
use '2kabhishek/template.nvim'

🚀 Usage

Fork the template.nvim repo
Update the plugin name, file names etc, change template to your-plugin-name
Add the code required for your plugin,
- Main logic, config options for the plugin code goes into lua/template
- Supporting code goes into lua/modules if needed
- For adding commands and keybindngs use plugin/template
Add test code to the tests file
Update the README
Tweak the docs action file to reflect your username, commit message and plugin name
- Generating vimdocs needs write access to actions (repo settings > actions > general > workflow permissions)

Configuration

template.nvim can be configured using the following options:

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:

<leader>th, for TemplateHello

NOTE: By default there are no configured keybindings.

Help

Run :help nerdy for more details.

🏗️ What's Next

Planning to add <feature/module>.

✅ To-Do

Setup repo
Think real hard
Start typing

⛅ Behind The Code

🌈 Inspiration

template.nvim was inspired by nvim-plugin-template, I added some changes on top to make setting up a new plugin faster.

💡 Challenges/Learnings

The main challenges were <issue/difficulty>
I learned about <learning/accomplishment>

🧰 Tooling

dots2k — Dev Environment
nvim2k — Personalized Editor
sway2k — Desktop Environment
qute2k — Personalized Browser

🔍 More Info

nerdy.nvim — Find nerd glyphs easily
tdo.nvim — Fast and simple notes in Neovim
termim.nvim — Neovim terminal improved

⭐ hit the star button if you found this useful ⭐