scribe

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

(★ 35)

scribe is a minimalist, opinionated LaTeX document class for academic technical writing, presentations, and resume.

scribe Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# `scribe`

**`scribe`** is a minimalist, opinionated $\LaTeX$ document class, beamer style, and CV class for academic technical writing, presentations, and resumes.

## 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, placed reliably in the outer margin of each column (even in two-column layouts and across page breaks).
- **Callout boxes**: Colored boxes for asides — `info`, `warn`, `tip`, `note` out of the box, plus inline variants. Define your own with `\scribedefinebox{name}{color}`.
- **Theorem-like boxes**: Numbered, referenceable environments for `theorembox`, `definitionbox`, `lemmabox`, `corollarybox`, `propositionbox`, `examplebox`, `remarkbox`. They share one counter that restarts each section and support `\label`/`\ref`. Define your own with `\scribedefinetheorem{name}{Heading}{color}`.
- **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: **Inconsolata** (default; comment it out and uncomment the `beramono` line in the class to use **Bera Mono** instead)
- **Matching Beamer theme**: `beamerthemescribe` brings the same style to slides (see [below](#beamer-theme)).
- **Matching CV class**: `scribecv` brings the same style to CVs and resumes (see [below](#cv--resume)).
- **Matching Matplotlib theme**: `matplotlib/` brings the same identity to figures (see [below](#matplotlib-theme)).

---

## LaTeX class

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, % Comment for single 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}
```

### Callout and theorem boxes

```latex
% Callout boxes (no number): info, warn, tip, note are predefined.
\begin{infobox}{A title}
    Some highlighted aside.
\end{infobox}
Inline flavors too: \infoboxinline{info}, \warnboxinline{warn}.
% Define your own:
\scribedefinebox{question}{Purple}

% Theorem-like boxes (numbered, referenceable). theorembox, definitionbox,
% lemmabox, corollarybox, propositionbox, examplebox, remarkbox are predefined.
\begin{definitionbox}[Factorial] % optional note in brackets
    \label{def:factorial}
    The factorial of $n$ is $n! = \prod_{k=1}^{n} k$, with $0! = 1$.
\end{definitionbox}
As stated in Definition~\ref{def:factorial}, ...
% Define your own:
\scribedefinetheorem{conjecturebox}{Conjecture}{BrickRed}
```

All theorem-like boxes share one counter that restarts each section, so their
numbers are unique within a section (e.g. Theorem 2.1, Definition 2.2). Write the
kind by hand when referencing, as is customary: `Theorem~\ref{...}`.

## Beamer theme

**`beamerthemescribe`** brings the `scribe` identity to slides: the same Libertine
serif and Inconsolata monospace fonts, the `MidnightBlue` accent, the `\scribedivider`
ornament, colored dingbats, and the toggleable named-comment system. A full
example is in the `example-beamer` folder. As in the paper class, you can switch
the monospace font back to Bera Mono by editing the `\RequirePackage` lines in
`beamerthemescribe.sty`.

### 1. Add `beamerthemescribe.sty` to your project folder.

### 2. In your main `.tex` file:

```latex
\documentclass[
    aspectratio=169, % 16:9 slides. Use 'aspectratio=43' for classic 4:3.
]{beamer}

\usetheme{scribe} % The scribe beamer theme
% Theme options:
%   \usetheme[noframenumbers]{scribe} % hide the frame counter in the footer
%   \usetheme[nosectionpages]{scribe} % no automatic section divider slides

\title{An example presentation\\ using the scribe beamer theme}
\subtitle{Minimalist slides, matching the paper}
\author[F. Bruzzone]{Federico Bruzzone \orcidlink{0000-0002-8701-8853}}
\institute{Università degli Studi di Milano}
\date{May 2026}

% Define aliases (and colors) for comments, just like the paper class
\scribedefinecomment{fb}{orange}
% \scribeshowcommentsfalse % Uncomment to hide comments in the final slides

\begin{document}

\begin{frame}[plain,noframenumbering]
    \titlepage
\end{frame}

\section{Introduction} % Triggers an automatic divider slide

\begin{frame}{A clean first slide}
    \begin{itemize}
        \item Triangle bullets in the accent color
    \end{itemize}
    \scribedivider % The signature ✦ ornament works on slides too
\end{frame}

\end{document}
```

> **Note:** Frames that contain verbatim material (`\verb`, `lstlisting`, …)
> must be declared `\begin{frame}[fragile]`, as required by `beamer`.

## CV / Resume

**`scribecv`** brings the `scribe` identity to CVs and resumes: the same Libertine
serif and Inconsolata monospace fonts, the `MidnightBlue` accent, the `\scribedivider`
ornament, colored dingbats, callout boxes, and the toggleable named-comment system.
A full example is in the `example-cv` folder.

### Features

- **Entry layout**: Date (bold, right-aligned) + content (left-aligned) with optional details line
- **Section headings**: Small caps with horizontal rule, matching the Typst CV style
- **Two-column info block**: Personal information on the left, contact info on the right
- **Publication support**: Full citations from `.bib` via `bibentry` package (`\bibentry{key}`)
- **Contact icons**: `fontawesome5` icons for GitHub, LinkedIn, Telegram, Twitter, Reddit, etc.
- **Section heading styles**: Default centered (`---- ✧ ---- NAME ---- ✧ ----`) or fill-style (`NAME ---- ✧ ----` filling to the right margin). Enable fill-style with `\documentclass[sectionfill]{scribecv}`.
- **Optional header**: Show your name in the top-right corner of each page with `\documentclass[header]{scribecv}`.
- **Matching identity**: Same Libertine, MidnightBlue, `\scribedivider` as the paper class

### 1. Add `scribecv.cls` to your project folder.

### 2. In your main `.tex` file:

```latex
\documentclass{scribecv}
% Or with options:
% \documentclass[sectionfill,header]{scribecv}
%
% Options:
%   sectionfill - fill-style section headings (NAME ---- ✧ ----)
%   header      - show your name in the top-right header on each page

\scribesetrightmark{Your Name}

% Bibliography
\bibliographystyle{unsrt}
\scribenobibliography{cv.bib}  % loads .bbl data for inline citations

\begin{document}

\scribename{Your Name}
\scribesubtitle{Curriculum Vitae}

\scribeinfo{%
    Born in City, Country \\
    E-mail: \href{mailto:you@example.com}{you@example.com}%
}{%
    \faGithub\ \href{https://github.com/you}{github.com/you} \\
    \faTelegram\ \href{https://t.me/you}{@you} \\
    \faLinkedin\ \href{https://linkedin.com/in/you}{in/you} \\
    \faTwitter\ \href{https://x.com/you}{@you}%
}

\maketitle

\scribesection{Education}
\scribeentry{2020--2024}{PhD in Computer Science at University of X}{}
\scribeentry{2018--2020}{MSc in Computer Science at University of X}{Thesis: \textit{...}}

\scribesection{Publications}

% Journal paper format:
\noindent{\small\textit{Journal Name} --- \bibentry{author2024} ---~%
\href{url}{bib} \enspace \href{url}{pdf} \enspace \href{url}{DOI}}\par

\vspace{4pt}

% Preprint format:
\noindent{\small\bibentry{author2023} ---~%
\href{url}{arXiv}}\par

\scribesection{Experience}
\scribeentry{2024--Present}{Software Engineer at Company X}{Working on Y}

\scribefooter{City}
\end{document}
```

## Matplotlib theme

**`matplotlib/`** brings the `scribe` identity to figures: the `MidnightBlue`
accent (`#007091`) with its HSL complement, recessive axes (baseline spine
only, hairline y-only gridlines), and serif typography matching the paper's
Libertine via font substitution (no usetex/pgf dependency). Two files:

- `scribe-theme.mplstyle` — portable style sheet, usable from any repo via
  `plt.style.use("/path/to/scribe-theme.mplstyle")`, or copy/symlink it into
  `~/.matplotlib/stylelib/` to use it by name.
- `scribe_mpl.py` — shared palette and mechanics: `setup()` (loads the style),
  `style_axes()` (per-axis grid selection), `rounded_bars()` (rounded-top bar
  groups), `label_bars()`. It knows nothing about a given paper's entities —
  assign your data series to the palette in a small per-paper module.

```python
from scribe_mpl import setup, style_axes
setup()  # once, before creating any Axes
fig, ax = plt.subplots()
style_axes(ax)  # recessive axes, y-only gridlines
# ... plot ...
```

Reusing the theme in a new project: copy both files verbatim, then write a
small module mapping your entities to the palette colors.

scribe

scribe Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

scribe

scribe Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README