Skip to content

Commit

Permalink
auto-generate vimdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Aug 30, 2024
1 parent da45baa commit 3d93240
Showing 1 changed file with 24 additions and 45 deletions.
69 changes: 24 additions & 45 deletions doc/my-template-docs.txt
Original file line number Diff line number Diff line change
@@ -1,69 +1,48 @@
*my-template-docs.txt* For Neovim >= 0.8.0 Last change: 2024 January 18
*my-template-docs.txt* For Neovim >= 0.8.0 Last change: 2024 August 30

==============================================================================
Table of Contents *my-template-docs-table-of-contents*

1. A Neovim Plugin Template |my-template-docs-a-neovim-plugin-template|
- Using it |my-template-docs-a-neovim-plugin-template-using-it|
- Features and structure|my-template-docs-a-neovim-plugin-template-features-and-structure|
1. Nvim plugin for helm-ls |my-template-docs-nvim-plugin-for-helm-ls|
- Planned features|my-template-docs-nvim-plugin-for-helm-ls-planned-features|
- Installing |my-template-docs-nvim-plugin-for-helm-ls-installing|
2. Links |my-template-docs-links|

==============================================================================
1. A Neovim Plugin Template *my-template-docs-a-neovim-plugin-template*
1. Nvim plugin for helm-ls *my-template-docs-nvim-plugin-for-helm-ls*

helm-ls <https://github.com/mrjosh/helm-ls/>

**Major work in progress**

A template repository for Neovim plugins.

PLANNED FEATURES *my-template-docs-nvim-plugin-for-helm-ls-planned-features*

USING IT *my-template-docs-a-neovim-plugin-template-using-it*

Via `gh`

>
$ gh repo create my-plugin -p ellisonleao/nvim-plugin-template
<

Viagithub web page:

Click on `Use this template`
- **WIP**Overwrite templates with their current values using virtual text demo
<https://github.com/mrjosh/helm-ls/issues/26#issuecomment-2308893242>
- **WIP**Show hints highlighting the effect of `nindent` and `indent` functions


INSTALLING *my-template-docs-nvim-plugin-for-helm-ls-installing*


FEATURES AND STRUCTURE*my-template-docs-a-neovim-plugin-template-features-and-structure*
USING LAZY ~

- 100% Lua
- Github actions for:
- running tests using plenary.nvim <https://github.com/nvim-lua/plenary.nvim> and busted <https://olivinelabs.com/busted/>
- check for formatting errors (Stylua)
- vimdocs autogeneration from README.md file
- luarocks release (LUAROCKS_API_KEY secret configuration required)


PLUGIN STRUCTURE ~

>
.
├── lua
│   ├── plugin_name
│   │   └── module.lua
│   └── plugin_name.lua
├── Makefile
├── plugin
│   └── plugin_name.lua
├── README.md
├── tests
│   ├── minimal_init.lua
│   └── plugin_name
│   └── plugin_name_spec.lua
>lua
{
"qvalentin/helm-ls.nvim",
ft = "helm",
opts = {},
}
<

If you are not using lazy make sure to call `require("helm-ls").setup()` in
your lua config.

==============================================================================
2. Links *my-template-docs-links*

1. *GitHub Workflow Status*: https://img.shields.io/github/actions/workflow/status/ellisonleao/nvim-plugin-template/lint-test.yml?branch=main&style=for-the-badge
2. *Lua*: https://img.shields.io/badge/Made%20with%20Lua-blueviolet.svg?style=for-the-badge&logo=lua
3. **: https://docs.github.com/assets/cb-36544/images/help/repository/use-this-template-button.png
1. *demo for indent hints*: https://raw.githubusercontent.com/qvalentin/helm-ls.nvim/main/doc/gifs/indent-hints.gif

Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>

Expand Down

0 comments on commit 3d93240

Please sign in to comment.