This template is a replication/implementation of the classic article LaTeX class in Typst. It is designed to be used for writing articles, papers, and other documents. It is a good starting point for people transitioning from LaTeX to typst or students starting with academic writing.

Getting Started

You can use this template in the Typst web app by clicking Start from template on the dashboard and searching for rubber-article. Alternatively, you can use the CLI to kick this project off using the command

typst init @preview/rubber-article

This will create a new Typst project in the current directory with the rubber-article template, with some example content, applied.

The following code snippet shows the minimal example of how to use the template.

#import "@preview/rubber-article:0.5.0": *

#show: article

#maketitle(
  title: "The Title of the Paper",
  authors: ("Authors Name",),
  date: "September 2024",
)

It shall be noted here, that this is not an exact copy, but rather a very close reinterpretation, since typst is quite different to work with. Additionally some features, that have not been present in the original article class, have been added to this template. For example the header-line has been added, which in LaTeX would have needed the package fancyhdr. Also worth a mention is that the default paper size in Typst is the A4 format, while in the original the US Letter format is used.

In order to recreate the original article class, use the following settings.

#show: article.with(
  page-margins: 1.75in,
  page-paper: "us-letter",
)

Further Functionality

The template provides a few more functions and parameters to customize the document. For an indepth look into the functionality checkout the guide.

For now here are a few of the most important parameters of the main function.

#show: article.with(
  cols:2,
  eq-chapterwise:true,
  eq-numbering: "(1.1)",
  fig-caption-width: 70%,
  header-display: true,
  header-title: "Document Title",
  heading-numbering: "1.1",
  lang: "de",
  page-margins: 1.75in,
  page-numbering: "1",
  page-paper: "us-letter",
  ...,
)

Some features are not from the original LaTeX article class, but have been added, as they have been deemed useful or nice to have. An example would be the built-in header, which displays the Documents title and the current chapter name.

Contributing

Feel free to open an issue or a pull request in the repository. Questions, suggestions and feature requests are always welcome.

Local Installation

To install this template locally, follow the steps below:

• Install Just task runner
• Clone the repository
• run just install

The template can then be imported with

#import "@local/rubber-article:0.5.0"

To install the package in the preview namespace, run just install-preview instead.