Skip to content

Latest commit

 

History

History
87 lines (63 loc) · 4.05 KB

README.md

File metadata and controls

87 lines (63 loc) · 4.05 KB

LaTeX Styles

This repository contains LaTeX styles I find useful to write scientific papers along with common customizations. Everything here is built upon exsiting styles and packages found in most LaTeX suites (e.g., the excellent TeXLive distribution.) The basic style files must be downloaded from the publishers' website and placed somewhere where LaTeX can find them.

Installing

  • If you don't want to read the two bullets below, simply run install.sh.

  • Set the environment variable LATEX_STYLES to point to the top of this repository. E.g., if you cloned this repository to /some/dir/latex-styles then export LATEX_STYLES=/some/dir/latex-styles.

  • Add $LATEX_STYLES to your $TEXINPUTS, $BIBINPUTS and $BSTINPUTS to ensure LaTeX will find the style and bibliography files:

    export TEXINPUTS=.:$LATEX_STYLES/styles//:$TEXINPUTS
    export BSTINPUTS=.:$LATEX_STYLES/styles/common::
    export BIBINPUTS=.:$LATEX_STYLES/share::

    Note the double slash symbols and double colons.

Basic Styles

Editor Setup

Please see the wiki for instructions on how to set up your environment for an awesome LaTeX experience, including how to set up popular editors.

Customizations

The styles offer a number of standard customizations that I find useful across almost all scientific papers I write. Those include basic packages such as graphicx, tikz and others but also the following:

  • the ability to add a table of contents, which is not supported by all styles by default (at least not without serious conflicts), and which I find very useful while writing the paper

  • the inclusion of the todonotes package along with the ability to add a list of todo items, which is not supported by all styles either

  • a few commands to produce boxed lemmas, theorems and corollaries so as to make them stand out. Some style files seem to go to great lengths to make lemmas, theorems and corollaries blend in so much with the text that you almost can't see them

  • integration with git.

Some choices have been made that may not be to everybody's taste but that fit my needs and preferences best. Among them:

  • the bibliography style is always natbib's abbrvnat style. Thus we never use \cite but only \citep and \citet. See the natbib reference sheet.

GitHub Actions

In order for GitHub Actions to work properly, set the following permissions in your repository's settings, under Actions > General:

  • Check Action permissions > Allow all actions and reusable workflows.
  • Check Workflow permissions > Read and write permissions.
  • Check Allow GitHub Actions to create and approve pull requests.