https://github.com/federicobruzzone/scribe
scribe is a minimalist, opinionated Latex document class for academic and technical writing.
https://github.com/federicobruzzone/scribe
latex latex-class latex-template typography
Last synced: 4 months ago
JSON representation
scribe is a minimalist, opinionated Latex document class for academic and technical writing.
- Host: GitHub
- URL: https://github.com/federicobruzzone/scribe
- Owner: FedericoBruzzone
- License: apache-2.0
- Created: 2025-06-30T05:51:49.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-06-30T10:27:42.000Z (4 months ago)
- Last Synced: 2025-06-30T11:29:13.104Z (4 months ago)
- Topics: latex, latex-class, latex-template, typography
- Language: TeX
- Homepage:
- Size: 588 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-Apache
Awesome Lists containing this project
README
# `scribe`
**`scribe`** is a minimalist, opinionated $\LaTeX$ document class for academic and technical writing. It is designed to provide clean defaults, professional typography, and convenient commands for research papers, systematic literature reviews, and technical reports. It is partially inspired by the `acmart` class.
---
## Features
- **Minimalist Design**: Focuses on content with a clean, professional layout.
- **Full support** for all standard `article` class options.
- **Index Terms**: Use `\begin{indexterms}` to define keywords for indexing.
- **Line Numbers**: Optional line numbering for easy reference and review.
- **Citation style**:
- Compact numeric citations (e.g., [1–3,5])
- Sorted in order of **first appearance**, not numerically
- **Named inline comments (toggleable)**:
- Define with `\scribedefinecomment{name}{color}`
- Use with `\namecomment{...}`
- Disable globally with `\scribeshowcommentsfalse`
- **Custom header mark**: `\scribesetrightmark{...}` sets right-side header text
- **Typography**:
- Serif: **Libertine**
- Monospace: **Bera Mono**
---
## Usage
An example of a paper using the `scribe` class is provided in the `example` folder.
Below is a minimal setup to have a one-column abstract in a two-column layout, with line numbers.
### 1. Add `scribe.cls` to your project folder.
### 2. In your main `.tex` file:
```latex
\documentclass[
lineno, % Enable line numbers.
letterpaper, % Use 'a4paper' for A4 size.
twocolumn, % Uncomment for two-column layout.
]{scribe}
% Set right header mark (e.g., your name)
\scribesetrightmark{Federico Bruzzone}
% Define different aliases (along with colors) for comments
\scribedefinecomment{fb}{orange}
% \scribedefinecomment{yourcolleague}{red}
% Uncomment the following line to hide comments in the final document.
% \scribeshowcommentsfalse
\title{\textbf{An example paper using the scribe document class}}
\author{
Federico Bruzzone \orcidlink{0000-0002-8701-8853} \\
Computer Science Department \\
Università degli Studi di Milano \\
\href{mailto:federico.bruzzone@unimi.it}{\texttt{federico.bruzzone@unimi.it}} \\
\url{https://federicobruzzone.github.io/}
}
\date{September 2025}
\begin{document}
\twocolumn[
\maketitle
\begin{abstract}
% Abstract text goes here. This is a brief summary of the document's content, highlighting the main objectives, methods, and findings.
\end{abstract}
\begin{indexterms}
% Index terms for indexing purposes. These are keywords that help categorize the document's content.
\end{indexterms}
]
% ==============================
% ========== Sections ==========
% ==============================
\input{sects/introduction}
\input{sects/background}
\bibliography{local}
\end{document}
```
---
This repository follows the [standard-commit](https://github.com/standard-commits/standard-commits) message format.