https://github.com/lukasl-dev/elegantex
A fancy LaTeX template.
https://github.com/lukasl-dev/elegantex
Last synced: 5 months ago
JSON representation
A fancy LaTeX template.
- Host: GitHub
- URL: https://github.com/lukasl-dev/elegantex
- Owner: lukasl-dev
- License: mit
- Created: 2023-12-06T20:48:19.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-12-07T22:05:23.000Z (over 2 years ago)
- Last Synced: 2025-09-05T11:15:05.346Z (10 months ago)
- Language: TeX
- Homepage:
- Size: 175 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Citation: CITATION.cff
Awesome Lists containing this project
README
# elegantex
## Motivation
This LaTeX template was initially created for my diploma thesis at [HTL Spengergasse](https://spengergasse.at/). Due to the good feedback from my teachers and other colleagues, I decided to make it publicly available.
## Setup
### Git Setup
If you use LaTeX inside of a Git repository, it is recommended to add this repository as a Git submodule:
```bash
git submodule add https://github.com/lukasl-dev/elegantex
```
### Manual Setup
You can use it manually by creating a `elegantex` directory and move the `elegantex.cls` file into it:
```bash
> tree
.
├── elegantex
│ └── elegantex.cls
└── main.tex
2 directories, 2 files
```
> You probably want to go for the manual approach when you want to customise the template.
## Usage
This template can be used as document class inside of your `.tex` file:
```tex
\documentclass{elegantex/elegantex}
```
After declaring the document class, you can define the following parameters:
```tex
\title{EleganTeX} % required
\subtitle{Template} % optional
\author{Lukas Leeb} % optional
\slogan{A LaTeX class for elegant articles} % optional
\logo{logo_transparent.png} % optional
```
### Title Page
The regular `\maketitle` LaTeX command is overriden by the template. You can use it inside of your document body:
```tex
\begin{document}
\maketitle
\section{History}
A brief history of time...
\end{document}
```
## Full Example
```tex
\documentclass{elegantex/elegantex}
\title{EleganTeX} % required
\subtitle{Template} % optional
\author{Lukas Leeb} % optional
\slogan{A LaTeX class for elegant articles} % optional
\logo{logo_transparent.png} % optional
\begin{document}
\maketitle
\tableofcontents
\newpage
\section{Introduction}
Some introduction text...
\end{document}
```