Skip to content

CheatsheetTemplate

The LaTeX4Ei Template is the solution for writing beautiful cheat sheets. In this section we explain how to get started using our template.

Example

Here is our documentation PDF that demonstrates the template’s output:

Using the Template

1. Setting Up Your Repository

  1. Create Your Repository: Click the "Use this template" button on our CheatsheetTemplate GitHub repository to create a new repository. Alternatively, you can clone the repository.

  2. Download the Required Package: To compile locally, you must have the latest LaTeX4Ei package. Get it from: https://github.com/latex4ei/latex4ei-packages/releases

  3. Place the Package: Unzip latex4ei.zip (from the package download) and move the entire latex4ei folder into the root of your repository.

If you want to permanently install our package, copy the latex4ei folder into your TeX distribution directory.

  • Windows
 Copy files to C:\texlive\XXXX\texmf-dist\tex\latex\latex4ei
  • Linux
sudo cp -r latex4ei /usr/share/texlive/texmf-dist/tex/latex/latex4ei
sudo mktexlsr
  • Mac OS X
cp -r latex4ei /usr/local/texlive/texmf-local/tex/latex/latex4ei

2. Update Environment (if using GitHub Actions)

  1. Rename Your File: Rename the provided CheatsheetTemplate.tex file to exactly match the name of your repository. This ensures proper integration with our build process.

  2. Update Build Files: Follow these steps to automatically update the build files:

  3. Go to your repository on GitHub.

  4. Click on the Actions tab.
  5. Locate and trigger the "Update README and LaTeX Build File" action.

This action automatically updates your README and the CMake build file with your repository’s name, ensuring your build configuration is set up correctly.

3. Compile Your Cheat Sheet

Now you can start adding content to your .tex file. You can compile your document:

  • Locally: With the latex4ei folder in your repository root, compile using your preferred LaTeX compiler (e.g., pdflatex).

  • Via GitHub Actions: When you push your changes, our GitHub action will automatically compile your cheat sheet. The generated PDF is available in the gh-pages branch or as an artifact of the workflow run.

Questions?

For questions or contributions, visit our GitHub or contact us at info@latex4ei.de.