Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mrp01/prettytex
LaTeX templates and base classes for university
https://github.com/mrp01/prettytex
latex latex-package latex-template
Last synced: about 20 hours ago
JSON representation
LaTeX templates and base classes for university
- Host: GitHub
- URL: https://github.com/mrp01/prettytex
- Owner: MrP01
- Created: 2020-10-19T09:10:21.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-04-03T16:48:59.000Z (8 months ago)
- Last Synced: 2024-04-16T03:20:36.496Z (7 months ago)
- Topics: latex, latex-package, latex-template
- Language: TeX
- Homepage:
- Size: 4.14 MB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
Awesome Lists containing this project
README
# Write prettier LaTeX
Some LaTeX templates and base classes for university, formal letters, legal things, etc.
You can find the documentation [here](./docs/prettytex.pdf).
Also, have a look at the [provided templates](./templates/).
## Usage
In almost all cases, use an article base document, like so:
```latex
\documentclass{article}
\usepackage{prettytex/base}
\usepackage{prettytex/math}
% or rather, if you use another language:
\usepackage[de]{prettytex/base}
\usepackage[de]{prettytex/math}
```
This package uses a modular approach, you may want to load some of the following packages. Keep in mind that `prettytex/base` always comes first.
```latex
\documentclass{article}
\usepackage{prettytex/base} % You always want this
\usepackage{prettytex/boxes} % thmbox and leftbar (box environments), also wrapthm
\usepackage{prettytex/math} % standard math tools (requires base)
\usepackage{prettytex/mathematicians} % hyperrefs to wikipedia to common mathematicians
\usepackage{prettytex/shortcuts} % shortcuts for vectors and matrices
\usepackage{prettytex/math-sigtrans} % utilities for signal transforms (requires math)
\usepackage{prettytex/code} % configuration for the minted package for including code
\usepackage{prettytex/contract} % useful commands for contracts and legal stuff
\usepackage{prettytex/gfx} % base class for grapics related work
\usepackage{prettytex/gfx-components} % control flow shortcuts
\usepackage{prettytex/gfx-circuits} % shortcuts for electrical circuits
\usepackage{prettytex/thesis} % scientific thesis options (pre-defined bibliography, typing)
```
Please be curious about the source code, you will find all answers inside.
Have fun! If you find a problem, please open a corresponding issue.
## Global installation on your Unix-based system
In the future, you might be able to install the package from CTAN.
For now, on Debian-based distributions, you need to clone this repository, link it and have tex know that something changed:
```bash
git clone [email protected]:MrP01/prettytex.git /path/to/your/repo
sudo ln -s /path/to/your/repo /usr/share/texlive/texmf-dist/tex/latex/prettytex
sudo texhash
```
## Getting minted to work
Based on a sample-size of two (Kubuntu and Arch Linux) operating systems, the `minted` package can cause some problems
when compiling, usually with the package `pygmentize` being missing on your system. You may install it with
```bash
sudo apt-get install pygmentize
```
on Debian based systems or:
```bash
sudo pacman -S pygmentize
```
on Arch Linux based systems. Now you only need to pass the `-shell-escape` flag to your latex-compiler. If you
are using the VSCode extension _Latex Workshop_, you need to edit the `settings.json` and add the flag to the
`args` of the recipe you are using. For example:
```json
"latex-workshop.latex.tools": [
{
"name": "latexmk",
"command": "latexmk",
"args": [
"-shell-escape", // <-- added the flag here
"-synctex=1",
"-interaction=nonstopmode",
"-file-line-error",
"-pdf",
"-outdir=%OUTDIR%",
"%DOC%"
],
"env": {}
},
{
"name": "pdflatex",
"command": "pdflatex",
"args": [
"-shell-escape", // <-- added the flag here
"-synctex=1",
"-interaction=nonstopmode",
"-file-line-error",
"%DOC%"
],
"env": {}
}
]
```
Keep in mind, that you have to pass `-shell-escape` before the `%DOC%` argument.
## math-theorems
If you already used prettytex in the past, then you probably remember the tcolorbox-theorems. These have been
deprecated (they are still present in ``math-theorems.sty`` for legacy reasons) in favour of a more Tex-aligned
approach. Tcolorbox allows to wrap common ams-math theorems with styles. Hence we provide the simple
``\wrapthm{}{}`` command, which allows you to specify a theorem-environment and a colour to wrap
said environment in. Then you may use the environment as usual. An example for your preamble:
```latex
\newtheorem{theorem}{Theorem}
\wrapthm{theorem}{blue}
```
## VSCode Snippets
The file `vscode_snippets.json` provides valid snippets for vscode for use in latex-documents. Just copy the contents
into your snippets file, or save it under `~/.config/Code/User/snippets/` with the name `latex.json`.