Commit 7047e7d6 authored by Sergej Chodarev's avatar Sergej Chodarev
Browse files

Add README

parent 2a220ca4
# LaTeX image for Gitlab-CI
The image is based on Fedora because it allows to select individual TeXLive packages.
It contains two base collections:
* `latexrecommended` — recommended set of LaTeX packages and fonts
* `langczechslovak` — support for Slovak language
It also includes following additional packages:
* `biblatex` — BibLaTeX and Biber are more modern alternatives to BibTeX
* `biblatex-iso690` — ISO690 styles for formatting citations
* `cm-mf-extra-bold` — bold versions of some CM fonts (needed by CAI template)
* `glossaries` — Create glossaries and lists of acronyms
* `minted` — colorful code syntax highlighting using Pygments libraty
* `tcolorbox` — colored and framed text boxes
* `xargs` — utility to define commands with many optional arguments
## How to Use
Use the following `.gitlab-ci.yml` file. You need to set name of your main TeX file in the `MAIN_TEX_FILE` variable. In some cases you may need to modify parameters passed to `latexmk`, for example, add `-shell-escape` if you use minted.
```yaml
variables:
MAIN_TEX_FILE: name-of-main-tex-file-without-extension
pdf:
stage: build
image: git.kpi.fei.tuke.sk:4567/kpi/latex
script:
- latexmk -pdf -interaction=nonstopmode $MAIN_TEX_FILE
artifacts:
paths:
- $MAIN_TEX_FILE.pdf
expire_in: 2 weeks
```
## „Download PDF“ Project Badge
You can have a nice badge at the top of your Gitlab project page to access latest PDF of your document.
![download PDF](https://img.shields.io/badge/download-PDF-blue?logo=adobe-acrobat-reader)
Go to the Settings → General → Badges and add badge with the following parameters:
- Name: `download PDF`
- Link: `https://git.kpi.fei.tuke.sk/%{project_path}/-/jobs/artifacts/%{default_branch}/raw/name-of-main-tex-file.pdf?job=pdf`
- Badge image URL: `https://img.shields.io/badge/download-PDF-blue?logo=adobe-acrobat-reader`
Don't forget to change the `name-of-main-tex-file` in the link URL.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment