![Conda Version](https://img.shields.io/conda/vn/conda-forge/texplain.svg)
Documentation: https://texplain.readthedocs.io
Usage
command-line
-
texindent:
Automatic indentation and formatting of a TeX-file.
-
texcleanup:
Apply any of the following options to a TeX-file:
- Remove all comments or comment-lines.
- Modify all occurrences of a command, for example to change
\TG{deleted}{inserted}
to inserted
. - Rename a label.
- Ensure common prefixes for all labels.
- Ensure usage of
\cref
instead of \ref
.
-
texplain:
Create a directory with a TeX-file and only its dependencies
(those figure-files and references that are actually included).
This is particularly useful to create a clean version to submit to a journal.
pre-commit
-
texcleanup:
repos:
- repo: https://github.com/tdegeus/texplain
rev: v0.8.0
hooks:
- id: texcleanup
args: [--format-labels, --use-cleveref]
-
texindent:
repos:
- repo: https://github.com/tdegeus/texplain
rev: v0.8.0
hooks:
- id: texindent
args: []
Python
All of these tools wrap around a
Python module
that you can use just as well!
Disclaimer
This library is free to use under the
MIT license.
Any additions are very much appreciated, in terms of suggested functionality, code, documentation,
testimonials, word-of-mouth advertisement, etc.
Bug reports or feature requests can be filed on GitHub.
As always, the code comes with no guarantee.
None of the developers can be held responsible for possible mistakes.
Download:
.zip file |
.tar.gz file.
(c - MIT) T.W.J. de Geus (Tom) |
tom@geus.me |
www.geus.me |
github.com/tdegeus/texplain
Getting texplain
Using conda
conda install -c conda-forge texplain
Using PyPi
python -m pip install texplain
From source
git checkout https://github.com/tdegeus/texplain.git
cd texplain
python -m pip install .