Skip to content

Commit

Permalink
chore(docs): auto generate vimdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
folke authored and github-actions[bot] committed Sep 6, 2022
1 parent 89ee420 commit a57b18c
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion doc/todo-comments.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
*todo-comments.txt* For NVIM v0.5.0 Last change: 2022 September 05
*todo-comments.txt* For NVIM v0.5.0 Last change: 2022 September 06

==============================================================================
Table of Contents *todo-comments-table-of-contents*
Expand Down Expand Up @@ -151,6 +151,27 @@ Todo comes with the following defaults:
<


JUMPING ~

Two methods are available to jump to the next/previous todo comment.

>
vim.keymap.set("n", "]t", function()
require("todo-comments").jump_next()
end, { desc = "Next todo comment" })
vim.keymap.set("n", "[t", function()
require("todo-comments").jump_prev()
end, { desc = "Previous todo comment" })
-- You can also specify a list of valid jump keywords
vim.keymap.set("n", "]t", function()
require("todo-comments").jump_next({keywords = { "ERROR", "WARNING" }})
end, { desc = "Next error/warning todo comment" })
<


🚀 USAGE *todo-comments-🚀-usage*

**Todo** matches on any text that starts with one of your defined keywords (or
Expand Down

0 comments on commit a57b18c

Please sign in to comment.