Linted LaTeX

A bare-bones LaTeX project with a simple linter included to be used as starter code for homework in the SOFT 260 course at UNL if students opt to typeset their work in LaTeX. The file template.tex demonstrates the basic LaTeX commands that are relevant to the course, and the linter detects common LaTeX mistakes.

Quick Start

Recursively clone this repository and cd into the root folder:

$ git clone --recursive git@git.unl.edu:soft-core/soft-260/linted-latex.git
$ cd linted-latex

(If you forget --recursive when cloning, you can cd into your clone and run git submodule update --init --recursive instead.)

Install dependencies:

$ npm install

Optionally run the linter:

$ npm run lint

Instructions

Copy template.tex to a new file in the src folder and edit and build it using your preferred LaTeX toolchain. The linter is run by a pre-commit hook, so it will check your LaTeX style whenever you commit.