Skip to main content

Write scientific preprints in Markdown. Generate publication-ready PDFs efficiently.

Project description

DOI License GitHub stars

Rxiv-Maker

Rxiv-Maker converts enhanced Markdown into professional PDFs with automated figure generation, citation management, and LaTeX typesetting. Write in Markdown, get publication-ready output for arXiv, bioRxiv, and other preprint servers.

Installation

macOS (includes LaTeX automatically):

brew install henriqueslab/formulas/rxiv-maker

Linux / Windows (WSL):

pipx install rxiv-maker    # or: uv tool install rxiv-maker

Verify setup:

rxiv check-installation

LaTeX is required. See the installation guide for platform-specific LaTeX instructions.

Quick Start

rxiv init my-paper
cd my-paper
rxiv pdf

To explore a complete working example:

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

Features

  • Enhanced Markdown - Scientific cross-references (@fig:plot, @eq:formula), auto-numbered figures/tables/equations, LaTeX math
  • Automated figures - Python and R scripts executed during PDF generation, with intelligent caching
  • Executable code blocks - Jupyter-like {{py:exec}} and {{py:get variable}} for live data in manuscripts
  • Citation management - BibTeX with [@citation] syntax, multiple styles, inline DOI resolution
  • Dual output - PDF and DOCX from the same source
  • arXiv/bioRxiv submission - Generate submission packages automatically
  • Track changes - Visual diff between manuscript versions
  • VS Code extension - Syntax highlighting, citation autocompletion, one-click builds

Documentation

rxiv-maker.henriqueslab.org - Installation, guides, CLI reference, troubleshooting.

For contributors: CONTRIBUTING.md

Ecosystem

Repository Purpose
rxiv-maker Core CLI tool
docker-rxiv-maker Pre-configured container with LaTeX
manuscript-rxiv-maker Complete example (arXiv:2508.00836)
vscode-rxiv-maker VS Code extension

Publications

Publication Venue
Rxiv-Maker: an automated template engine for streamlined scientific publications arXiv (2025)
Customizable FDM-based zebrafish embryo mold for live imaging bioRxiv (2025)
mAIcrobe: an open-source framework for high-throughput bacterial image analysis bioRxiv (2025)
Filopodome proteomics identifies CCT8 as a MYO10 interactor critical for filopodia functions bioRxiv (2025)
EZInput: A Cross-Environment Python Library for Easy UI Generation in Scientific Computing arXiv (2026)
Packaging Jupyter notebooks as installable desktop apps using LabConstrictor arXiv (2026)

Using Rxiv-Maker for your research? Let us know.

Community

Citation

@misc{saraiva_2025_rxivmaker,
  title={Rxiv-Maker: an automated template engine for streamlined scientific publications},
  author={Bruno M. Saraiva and Ant\'{o}nio D. Brito and Guillaume Jaquemet and Ricardo Henriques},
  year={2025},
  eprint={2508.00836},
  archivePrefix={arXiv},
  url={https://arxiv.org/abs/2508.00836}
}

License

MIT License - see LICENSE for details.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rxiv_maker-1.21.0.tar.gz (1.8 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rxiv_maker-1.21.0-py3-none-any.whl (613.3 kB view details)

Uploaded Python 3

File details

Details for the file rxiv_maker-1.21.0.tar.gz.

File metadata

  • Download URL: rxiv_maker-1.21.0.tar.gz
  • Upload date:
  • Size: 1.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for rxiv_maker-1.21.0.tar.gz
Algorithm Hash digest
SHA256 b08c00fe52f611e15a44e61033b1faecda2538d0edeced730ef9f78805c2b874
MD5 ec3c34984f02a02ade4063180b064d8f
BLAKE2b-256 38366b5d613a9aea320194f90397ac444b36bd94f8e5bc6b75f9711072532875

See more details on using hashes here.

File details

Details for the file rxiv_maker-1.21.0-py3-none-any.whl.

File metadata

  • Download URL: rxiv_maker-1.21.0-py3-none-any.whl
  • Upload date:
  • Size: 613.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for rxiv_maker-1.21.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4d579d276313dac967c4b61fdb282faf0c6677adb3c17554153e77e3603c9640
MD5 0b9dc3d61925e323fe648250e20da588
BLAKE2b-256 7c1138eb7dd627e5144831a321ca91226d34794171e265376e1961afaa6a7695

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page