merge: rewrite-docs
I've omitted docs/*.org from this merge, as there is still work left to do there, but I am pushing the module docs early so folks can benefit from the new docs sooner.
This commit is contained in:
Henrik Lissner
commit
1f8bf7accb
179 changed files with 13125 additions and 8630 deletions
|
|
@ -1,83 +1,88 @@
|
|||
#+TITLE: :ui hl-todo
|
||||
#+DATE: February 19, 2017
|
||||
#+SINCE: v1.3
|
||||
#+STARTUP: inlineimages
|
||||
# -*- mode: doom-docs-org -*-
|
||||
#+title: :ui hl-todo
|
||||
#+subtitle: TODO FIXME NOTE DEPRECATED HACK REVIEW
|
||||
#+created: February 19, 2017
|
||||
#+since: 1.3
|
||||
|
||||
* Table of Contents :TOC_3:noexport:
|
||||
- [[#description][Description]]
|
||||
- [[#module-flags][Module Flags]]
|
||||
- [[#plugins][Plugins]]
|
||||
- [[#prerequisites][Prerequisites]]
|
||||
- [[#features][Features]]
|
||||
- [[#making-items][Making Items]]
|
||||
- [[#keybindings][Keybindings]]
|
||||
- [[#adding-items][Adding items.]]
|
||||
- [[#configuration][Configuration]]
|
||||
- [[#troubleshooting][Troubleshooting]]
|
||||
* Description :unfold:
|
||||
This module adds syntax highlighting for various tags in code comments, such as
|
||||
=TODO=, =FIXME=, and =NOTE=, among others.
|
||||
|
||||
* Description
|
||||
This module adds syntax highlighting for TODO/FIXME/NOTE tags in programming
|
||||
major-modes.
|
||||
** Maintainers
|
||||
- [[doom-user:][@hlissner]]
|
||||
|
||||
** Module Flags
|
||||
This module provides no flags
|
||||
[[doom-contrib-maintainer:][Become a maintainer?]]
|
||||
|
||||
** Plugins
|
||||
+ [[https://github.com/tarsius/hl-todo][hl-todo]]
|
||||
** Module flags
|
||||
/This module has no flags./
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][hl-todo]]
|
||||
|
||||
* Prerequisites
|
||||
This module has no prerequisites
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
||||
* Features
|
||||
** TODO Changelog
|
||||
# This section will be machine generated. Don't edit it by hand.
|
||||
/This module does not have a changelog yet./
|
||||
|
||||
** Making Items
|
||||
You can make a TODO item by simply writing
|
||||
+ =TODO=
|
||||
For things that need to be done, just not today.
|
||||
+ =HACK=
|
||||
For tidbits that are unconventional and not intended uses of the
|
||||
* Installation
|
||||
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]
|
||||
|
||||
/This module has no external requirements./
|
||||
|
||||
* TODO Usage
|
||||
#+begin_quote
|
||||
🔨 /This module's usage documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
|
||||
#+end_quote
|
||||
|
||||
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
|
||||
- =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
|
||||
- =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 |
|
||||
| keybind | description |
|
||||
|---------+----------------------------------|
|
||||
| [[kbd:][]t]] | go to next TODO item |
|
||||
| [[kbd:][[t]] | go to previous TODO item |
|
||||
| [[kbd:][SPC p t]] | show all TODO items in a project |
|
||||
| [[kbd:][SPC s p]] | search project for a string |
|
||||
| [[kbd:][SPC s b]] | search buffer for string |
|
||||
|
||||
** TODO Adding items.
|
||||
The way you would add a TODO item is to use a snippet but these have not been
|
||||
made. you can make them yourself by adding the snippet to
|
||||
=$DOOMDIR/snippets/MAJOR-MODE/name-of-snippet=. you will find more info on how
|
||||
to make them [[https://github.com/hlissner/doom-snippets][here]]
|
||||
* TODO Configuration
|
||||
#+begin_quote
|
||||
🔨 /This module's configuration documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
|
||||
#+end_quote
|
||||
|
||||
* Configuration
|
||||
To add your own ITEMS you would need to configure them using
|
||||
~hl-todo-keyword-faces~
|
||||
#+BEGIN_SRC emacs-lisp
|
||||
;; the default
|
||||
~hl-todo-keyword-faces~:
|
||||
#+begin_src emacs-lisp
|
||||
;; in $DOOMDIR/config.el
|
||||
(after! hl-todo
|
||||
(setq hl-todo-keyword-faces
|
||||
`(
|
||||
("FOO" . ,(face-foreground "MY COLOUR HEX CODE"))
|
||||
`(("FOO" . ,(face-foreground "MY COLOUR HEX CODE"))
|
||||
("BAR" . ,(face-foreground 'my-colour-var)))))
|
||||
#+END_SRC
|
||||
#+end_src
|
||||
|
||||
* TODO Troubleshooting
|
||||
If you have any problems with this module do get in touch!
|
||||
* Troubleshooting
|
||||
/There are no known problems with this module./ [[doom-report:][Report one?]]
|
||||
|
||||
* Frequently asked questions
|
||||
/This module has no FAQs yet./ [[doom-suggest-faq:][Ask one?]]
|
||||
|
||||
* TODO Appendix
|
||||
#+begin_quote
|
||||
🔨 This module has no appendix yet. [[doom-contrib-module:][Write one?]]
|
||||
#+end_quote
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue