mirror of
https://github.com/zoriya/ts-comments.nvim.git
synced 2026-08-16 02:44:39 +00:00
chore(build): auto-generate vimdoc
This commit is contained in:
@@ -0,0 +1,103 @@
|
|||||||
|
*ts-comments.nvim.txt* For Neovim >= 0.10.0 Last change: 2024 May 20
|
||||||
|
|
||||||
|
==============================================================================
|
||||||
|
Table of Contents *ts-comments.nvim-table-of-contents*
|
||||||
|
|
||||||
|
1. ts-comments.nvim |ts-comments.nvim-ts-comments.nvim|
|
||||||
|
2. Requirements |ts-comments.nvim-requirements|
|
||||||
|
3. Installation |ts-comments.nvim-installation|
|
||||||
|
4. Configuration |ts-comments.nvim-configuration|
|
||||||
|
5. Related |ts-comments.nvim-related|
|
||||||
|
|
||||||
|
==============================================================================
|
||||||
|
1. ts-comments.nvim *ts-comments.nvim-ts-comments.nvim*
|
||||||
|
|
||||||
|
Tiny plugin to enhance Neovim’s native comments:
|
||||||
|
|
||||||
|
- Easily override the comment string for a given **treesitter** language
|
||||||
|
- Supports different comment strings for different **treesitter** node types
|
||||||
|
|
||||||
|
|
||||||
|
==============================================================================
|
||||||
|
2. Requirements *ts-comments.nvim-requirements*
|
||||||
|
|
||||||
|
- Neovim >= 0.10.0
|
||||||
|
|
||||||
|
|
||||||
|
==============================================================================
|
||||||
|
3. Installation *ts-comments.nvim-installation*
|
||||||
|
|
||||||
|
Using lazy.nvim <https://github.com/folke/lazy.nvim>
|
||||||
|
|
||||||
|
>lua
|
||||||
|
{
|
||||||
|
"folke/ts-comments.nvim",
|
||||||
|
opts = {}
|
||||||
|
event = "VeryLazy",
|
||||||
|
enabled = vim.fn.has("nvim-0.10.0") == 1,
|
||||||
|
}
|
||||||
|
<
|
||||||
|
|
||||||
|
|
||||||
|
==============================================================================
|
||||||
|
4. Configuration *ts-comments.nvim-configuration*
|
||||||
|
|
||||||
|
Default configuration:
|
||||||
|
|
||||||
|
>lua
|
||||||
|
{
|
||||||
|
lang = {
|
||||||
|
astro = "<!-- %s -->",
|
||||||
|
c = "// %s",
|
||||||
|
cpp = "// %s",
|
||||||
|
css = "/* %s */",
|
||||||
|
gleam = "// %s",
|
||||||
|
glimmer = "{{! %s }}",
|
||||||
|
graphql = "# %s",
|
||||||
|
handlebars = "{{! %s }}",
|
||||||
|
hcl = "# %s",
|
||||||
|
html = "<!-- %s -->",
|
||||||
|
ini = "; %s",
|
||||||
|
php = "// %s",
|
||||||
|
rego = "# %s",
|
||||||
|
rescript = "// %s",
|
||||||
|
sql = "-- %s",
|
||||||
|
svelte = "<!-- %s -->",
|
||||||
|
terraform = "# %s",
|
||||||
|
tsx = {
|
||||||
|
_ = "// %s",
|
||||||
|
call_expression = "// %s",
|
||||||
|
comment = "// %s",
|
||||||
|
jsx_attribute = "// %s",
|
||||||
|
jsx_element = "{/* %s */}",
|
||||||
|
jsx_fragment = "{/* %s */}",
|
||||||
|
spread_element = "// %s",
|
||||||
|
statement_block = "// %s",
|
||||||
|
},
|
||||||
|
javascript = {
|
||||||
|
_ = "// %s",
|
||||||
|
call_expression = "// %s",
|
||||||
|
comment = "// %s",
|
||||||
|
jsx_attribute = "// %s",
|
||||||
|
jsx_element = "{/* %s */}",
|
||||||
|
jsx_fragment = "{/* %s */}",
|
||||||
|
spread_element = "// %s",
|
||||||
|
statement_block = "// %s",
|
||||||
|
},
|
||||||
|
twig = "{# %s #}",
|
||||||
|
typescript = "// %s",
|
||||||
|
vim = '" %s',
|
||||||
|
vue = "<!-- %s -->",
|
||||||
|
},
|
||||||
|
}
|
||||||
|
<
|
||||||
|
|
||||||
|
|
||||||
|
==============================================================================
|
||||||
|
5. Related *ts-comments.nvim-related*
|
||||||
|
|
||||||
|
- nvim-ts-context-commentstring <https://github.com/JoosepAlviste/nvim-ts-context-commentstring>
|
||||||
|
|
||||||
|
Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>
|
||||||
|
|
||||||
|
vim:tw=78:ts=8:noet:ft=help:norl:
|
||||||
Reference in New Issue
Block a user