Skip to content

Examples

The fastest way to learn Rxiv-Maker is to read a real manuscript and build it yourself.

The official example manuscript

The Rxiv-Maker paper is written in Rxiv-Maker. Clone it, build it, and read the source alongside the output.

  • Clone and build

    rxiv get-rxiv-preprint
cd manuscript-rxiv-maker/MANUSCRIPT
rxiv pdf

    Source on GitHub

  • Published version

    Compare the source to the final PDF.

    arXiv:2508.00836

A minimal manuscript

Two files are enough to produce a PDF.

# 00_CONFIG.yml
title: "My First Scientific Paper"
authors:
  - name: "Your Name"
    affiliation: "1"
affiliations:
  - id: "1"
    name: "Your Institution"

# 01_MAIN.md

## Abstract
A short example demonstrating the basics [@smith2023].

## Results
Our analysis is summarised in Figure @fig:results.

![Analysis results](FIGURES/results.py)
{#fig:results}

## References

Run rxiv pdf in that folder to build it.

Common patterns

Published with Rxiv-Maker

See preprints and papers written with the tool, including how to find new ones automatically.

Publications Showcase

Share your example

Created something with Rxiv-Maker? Share it in GitHub Discussions.