Generate TODO markdown/PDF files from your LaTeX documents
MIT License
Extract all TODOs and FIXMEs from LaTeX project.
-h, --help Show this help message and exit
--outfile OUTFILE
-o OUTFILE Output file.
Supported extensions: md, tex, pdf.
Default: TODO.md
--directories DIRECTORIES
-d DIRECTORIES Comma separated list of directories.
Default: text
--files FILES
-f FILES Comma separated list of files.
Defaults to none.
--keywords KEYWORDS
-k KEYWORDS Comma separated list of keywords.
Default: FIXME,TODO,NOTE
--scheme SCHEME Color scheme for output PDF file.
Options: light, plain, mariana, marianne, dark.
Default: light
--description DESCRIPTION Set output file description.
Default: Statistics for this LaTeX project.
--footer FOOTER Set file footer.
Defaults to link to this project.
Multiple output files supported:
.md
). This is a default..tex
)..pdf
). Generates .tex
file and converts it using the latex
package.Several color schemes for output PDF are supported (see Gitlab docs page).
# Use default settings
latex-todo-gen
# Set custom keywords
latex-todo-gen -k "REVIEW,FIXME,TODO,NOTE"
# Set description and output file as PDF
latex-todo-gen --description "This file is generated on every commit." -o "WIP.pdf"
# Set source directories and one main file
latex-todo-gen -d "src,settings" -f "main.tex"
# Set color scheme for output PDF
latex-todo-gen -o "TODO.pdf" --scheme marianne
LaTeX sometimes fails when it tries to render a UTF-8 character it doesn't know. The \lstset
in the template tries to encode most of diacritics for european alphabets, as well as some of the common characters. If you encounter an error, let me know via issues.
PRs are welcome. I'm currently looking for:
.todo-gen.yaml
?%
with python's #
and you've got python-todo-gen. I'm probably migrate it sometime, but for now, it's just latex.# TODO3
would append three lines instead of one