awesome-emacs/doomemacs
1
0
Fork 0
mirror of https://github.com/doomemacs/doomemacs synced 2025-08-01 12:17:25 -05:00
Code Issues Packages Projects Releases Wiki Activity
Files
361eec11a4da3dd9ee16a05468a0a7e6a1ce4046
doomemacs/modules/ui/hl-todo
History
Henrik Lissner 94731a85c2 bump: :ui :input :config :checkers 
Alexander-Miller/treemacs@32bb3dd02d -> Alexander-Miller/treemacs@96a808f067
coldnew/pangu-spacing@2303013e5c -> coldnew/pangu-spacing@6509df9c90
dgutov/diff-hl@65a5de16e2 -> dgutov/diff-hl@7da881a957
ema2159/centaur-tabs@63eb35cf42 -> ema2159/centaur-tabs@7704f2017c
emacs-jp/migemo@7d78901773 -> emacs-jp/migemo@fbc16b57ea
emacs-lsp/lsp-treemacs@fb1a07ae0a -> emacs-lsp/lsp-treemacs@312dee2b3a
emacs-straight/use-package@e8c659a050 -> emacs-straight/use-package@d79bac4574
emacsorphanage/evil-anzu@d1e98ee697 -> emacsorphanage/evil-anzu@7309650425
flycheck/flycheck@86715c0f29 -> flycheck/flycheck@b9db1379dc
jaypei/emacs-neotree@599bd049a5 -> jaypei/emacs-neotree@4a4cd85761
jdtsmith/indent-bars@47ae080d9b -> jdtsmith/indent-bars@fa293f98ab
joostkremers/writeroom-mode@86965a56ed -> joostkremers/writeroom-mode@cca2b4b3cf
merrickluo/liberime@c5839f5417 -> merrickluo/liberime@23c0caa1bf
purcell/package-lint@21edc6d0d0 -> purcell/package-lint@43012b41ac
rainstormstudio/treemacs-nerd-icons@9876cb4781 -> rainstormstudio/treemacs-nerd-icons@eac9fb5d92
seagle0128/doom-modeline@9d6f0f9635 -> seagle0128/doom-modeline@1708db2d35
skk-dev/ddskk@8c47f46e38 -> skk-dev/ddskk@f81ed803e6
tarsius/hl-todo@fb692ec092 -> tarsius/hl-todo@0ce21c329b
tumashu/posframe@f4e9e509ba -> tumashu/posframe@12f540c9ad
tumashu/pyim@f22c20f2e6 -> tumashu/pyim@64731c213c
2025-04-01 03:47:37 -04:00
..
.doommodule
feat: add .doommodule files
2024-09-14 20:47:39 -04:00
config.el
refactor: minor refactors & commentary revision
2022-09-24 20:31:34 +02:00
packages.el
bump: :ui :input :config :checkers
2025-04-01 03:47:37 -04:00
README.org
docs(*): replace all-the-icons with nerd-icons
2023-09-16 20:19:11 +02:00

README.org

:ui hl-todo

Description   unfold

This module adds syntax highlighting for various tags in code comments, such as TODO, FIXME, and NOTE, among others.

Maintainers

Become a maintainer?

Module flags

This module has no flags.

Packages

Hacks

No hacks documented for this module.

TODO Changelog

This module does not have a changelog yet.

Installation

Enable this module in your doom! block.

This module has no external requirements.

TODO Usage

󱌣 This module's usage documentation is incomplete. Complete it?

By enabling this module, the following keywords will be highlighted if they occur in code comments:

  • TODO: For things that need to be done, just not today.
  • HACK: For tidbits that are unconventional and not intended uses of the constituent parts, and may break in a future update.
  • FIXME: For problems that will become bigger problems later if not fixed ASAP.
  • REVIEW: for things that were done hastily and/or hasn't been thoroughly tested. it may not even be necessary!
  • NOTE: For especially important gotchas with a given implementation, directed at another user other than the author.
  • DEPRECATED: For things that just gotta go and will soon be gone.
  • BUG: For a known bug that needs a workaround.
  • XXX: For warning about a problematic or misguiding code.

Keybindings

keybind description
]t go to next TODO item
[t go to previous TODO item
SPC p t show all TODO items in a project
SPC s p search project for a string
SPC s b search buffer for string

TODO Configuration

󱌣 This module's configuration documentation is incomplete. Complete it?

To add your own ITEMS you would need to configure them using hl-todo-keyword-faces:

;; in $DOOMDIR/config.el
(after! hl-todo
  (setq hl-todo-keyword-faces
        `(("FOO"  . ,(face-foreground "MY COLOUR HEX CODE"))
          ("BAR" . ,(face-foreground 'my-colour-var)))))

Troubleshooting

There are no known problems with this module. Report one?

Frequently asked questions

This module has no FAQs yet. Ask one?

TODO Appendix

󱌣 This module has no appendix yet. Write one?