Repository files navigation

This repo contains aLaTeX document, usable as a cookbook (different "recipes" to achieve various things in LaTeX) as well as as a template.The resulting PDF covers LaTeX-specific topics and instructions on compiling the LaTeX source.

See thereleases page for more downloads.

After installingDocker (and git), building works out of thebox:

• Bash:

  $git clone git@github.com:alexpovel/latex-cookbook.git$cd latex-cookbook$docker run --rm --volume$(pwd):/tex alexpovel/latex$xdg-open cookbook.pdf

• PowerShell:

  PS> git clone git@github.com:alexpovel/latex-cookbook.gitPS> cd latex-cookbookPS> docker run--rm--volume${PWD}:/tex alexpovel/latexPS>Invoke-Item cookbook.pdf

Theentrypoint islatexmk, which when given no arguments (asdone here) runs on all found*.tex files, which in this case is only the root'smainfile.

ThePDF itself has much more to say on this and is meant to speak for itself, visually.The following is simply a brief overview of the features contained in this repo.

• accompanyingDocker image, usable locally and in CI/CD, guaranteeing compilation success without interfering with your local installation.In fact, using Docker (containerization in general), no LaTeX installation is required at all.

  • accompanying Visual Studio Codeenvironment configuration.

    If you open this repository inVisual Studio Code, it should automatically put you into the correct Docker container environment for development, and just work™.Seehere for more info.

  • in the image,pandoc is available with theEisvogel template, allowing beautiful PDFs to be generated from Markdown (like this README: download it from the latestActions artifacts; it currently looks lackluster because this README is mainly PNGs)

• tests for your PDF, using Python to ensure some (basic) properties of your output adhere to expectations
• aMakefile to facilitate ease of use and platform independence (commands likemake file.pdf work locally as well as in CI pipelines)

• full Unicode support throughlualatex, thesuccessor to the obsoletepdflatex.This also affords beautiful font typesetting throughunicode-math.High-quality fonts likeTeX Gyre Pagella have all desirable font shapes available:

• automatic compilation usinglatexmk, ensuring the PDF is built fully, running all steps necessary (generation of the bibliography, glossaries, ...) automatically as needed

• comprehensive support for:

  • generatingindices,
  • typesetting and displayingsymbols in an automatically generated nomenclature,
  • acronyms and abbreviations, as well as
  • mathematical constants,

  made possible throughglossaries-extra.

• structured and commented source code, explaining rationales and providing context

• showcasing plotting and data display (floats):

  • computing more complicated plots (in this example, a contour plot)directly in LaTeX, with no explicit outside tools used (gnuplot is used by LaTeX in the background):

    

  • ingesting a CSV directly, and plotting it (so we can skipmatlab2tikz etc.).The below style is inspired byTufte:

    

  • typesetting more complex tables, with footnotes, decimal alignment and more:

    

  • using tikz:

    • for annotating bitmap graphics:

      

    • for drawing diagrams (this template contains a (basic)pgf/tikz library for energy systems/thermodynamics/hydraulics/... symbols like pipes, compressors, valves, ...) and 3D sketches.For a much better and comprehensive collection of TikZ examples, seehere.

      

• back-referencing of citations, using the excellentbiblatex:

  

• support for elaborate chemical reaction equations, usingchemmacros:

  

• comprehensive code syntax highlighting, thanks tominted andpygments:

  

• quick and structural switching of language contexts, provided bypolyglossia:

  

• of course, support for enhanced mathematical typesetting, like highlighted equations or premade macros.The blue color arehyperlinks, turning those symbols into links to the glossary (this can be toggled off).