Skip to content

Commit

Permalink
readme: List integrations
Browse files Browse the repository at this point in the history
  • Loading branch information
tarsius committed Aug 28, 2023
1 parent 0faf856 commit 5bb58f1
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.org
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,20 @@ commands, then you should bind them in ~hl-todo-mode-map~, e.g.:
(keymap-set hl-todo-mode-map "C-c i" #'hl-todo-insert)
#+end_src

*** FAQ and Common Issues

See [[https://github.com/tarsius/hl-todo/wiki][FAQ and Common Issues]] if something isn't working as expected.

*** Integrations

- Command ~hl-todo-occur~ uses ~occur~ to list TODO keywords.
- Command ~hl-todo-rgrep~ uses ~rgrep~ to list TODO keywords.
- Function ~hl-todo-flymake~ teaches [[https://www.gnu.org/software/emacs/manual/html_node/emacs/Flymake.html][flymake]] about TODO keywords.
- Package [[https://github.com/alvarogonzalezsotillo/flycheck-hl-todo][flycheck-hl-todo]] adds TODO keywords to [[https://github.com/flycheck/flycheck][flycheck]].
- Package [[https://github.com/alphapapa/magit-todos][magit-todos]] displays TODO keybords in [[https://github.com/magit/magit][magit]]'s status buffer.
- Package [[https://github.com/liuyinz/consult-todo][consult-todo]] supports searching and jumping to TODO keywords
using [[https://github.com/minad/consult][consult]].

#+html: <br><br>
#+html: <a href="https://github.com/tarsius/hl-todo/actions/workflows/compile.yml"><img alt="Compile" src="https://github.com/tarsius/hl-todo/actions/workflows/compile.yml/badge.svg"/></a>
#+html: <a href="https://stable.melpa.org/#/hl-todo"><img alt="MELPA Stable" src="https://stable.melpa.org/packages/hl-todo-badge.svg"/></a>
Expand Down

0 comments on commit 5bb58f1

Please sign in to comment.