/latex-template

Simple latex template powered by GitHub actions ✍🚀

Primary LanguageTeXMIT LicenseMIT

Latex template

Build LaTeX document Text quality

Simple latex project powered by GitHub actions

PDF output PDF output
PDF output PDF output

Get started

So you want to use this template? Just a few steps to go:

  1. Click Use this Template
  2. Set your data in ./templates/cover.tex and add your content in ./main.tex
  3. Optionally: To automatically push the generated PDF and update the images above uncomment the parts in ./.github/workflows/compile.yml and set your GitHub username.

🚀

Structure

├── dict.txt 👉 **Dictionary file for the spell checking(TexTidote)**
└── .textidote 👉 **Spell and linting config(Still beta ;-) )**
├── .github 👉 **GitHub actions automation**
├── img 👉 **Image folder**
├── main.tex 👉 **Your content here**
├── references 👉 **Your BibTex references here**
├── templates 👉 **Your templates here. F.ex cover, structure, packages,...**

Running

Requirements: Everything tested on Ubuntu 18.04 with texlive.

  1. latexmk for easy compilation and chktex for linting. They're normally already in your LaTeX distribution
  2. [OPTIONAL]: pdftoppm to generate images of your PDF
  3. [OPTIONAL]: TexTidote to check grammar, spelling and a little bit of linting

You can use the Makefile when using this template:

  • See the latexmk to learn more about it.
  1. make: Compile PDF
  2. make clean: Clean generated tmp files
  3. make cleanall: Clean all generated files. Also .pdf, .bbl,...
  4. make watch: Start compilation in watch mode. Useful for writing
  5. make open: Open the generated PDF in your PDF viewer

Optional:

  1. make images: Generate images from PDF pages
  2. make lint: Lint LaTeX file for errors with chktex
  3. make spellcheck: Do some spell/grammar checking and light linting with TexTiDote

Automation

This template comes with a GitHub actions automation:

  1. Compile project
  2. Check errors(chktex)
  3. Check Grammar and spelling(textidote)
  4. Optionally: Push updated PDF to repo and update images in README. For this, comment out and adapt the parts in ./.github/workflows/compile.yml

Helpful tools