Skip to content

ebnn/draftcheck

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

99 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

draftcheck

draftcheck is an LaTeX linter that is specifically designed for academic writing.

Installation

draftcheck can be installed using pip:

pip install draftcheck

You can also install it from source:

mkdir draftcheck && cd draftcheck
git clone https://github.com/ebnn/draftcheck.git
python setup.py install

Usage

The supplied files contains several example LaTeX files that can be used to test it.

$ draftcheck examples/simple.tex
examples/simple.tex:26:1: (http://www.comp.leeds.ac.uk/andyr/misc/latex/\-latextut...
                           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	[030] Wrap URLs with the \url command.

examples/simple.tex:31:37: ...thin \LaTeX\cite{lamport94}...
                                        ^^^^^^^
	[004] Place a single, non-breaking space '~' before citations.

examples/simple.tex:49:10: ...%Set up an 'itemize' environmen...
                                        ^^^^^^^^^^^
	[014] Use left and right quotation marks ` and ' rather than '.

examples/simple.tex:93:0: \begin{center}
                          ^^^^^^^^^^^^^^
	[015] Use \centering instead of \begin{center}.

examples/simple.tex:123:29: ...the number '9'. This is b...
                                         ^^^^^
	[014] Use left and right quotation marks ` and ' rather than '.


Total of 5 mistakes found.

About

LaTeX Lint for Academic Writing

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published