Quick start

npx create-research-article my-paper

The CLI walks you through setup interactively:

• Project name and basic metadata (title, authors, affiliations)
• Template choice: article (full layout with banner, TOC, citations, figure numbering, PDF export) or paper (lighter centered single-column layout)
• Hugging Face deployment (optional, auto-creates a Space if huggingface-cli is installed)

Then start writing:

cd my-paper/app
npm run dev              # dev server at localhost:4321

Deploy to Hugging Face

If you skipped the auto-deploy during setup, push manually:

# create a Docker Space at huggingface.co/new-space, then:
git remote add space git@hf.co:spaces/<your-username>/<your-space>
git push space main

The project ships with Dockerfile, nginx config, and HF Space metadata ready to go.

Template variants

Set template in app/src/content/article.mdx frontmatter:

External links (paper template)

The paper template supports external link buttons below the authors:

links:
  - label: "Paper"
    url: "https://arxiv.org/abs/..."
  - label: "Code"
    url: "https://github.com/..."
  - label: "Demo"
    url: "https://huggingface.co/spaces/..."

Title line breaks

Long titles are automatically balanced across lines. You can also force a line break with \n:

title: "Why Open-Source LLMs\nAre Reshaping the AI Landscape"

Titles longer than 60 characters are automatically downsized for readability.

Edit your content

Commands

Alternative setup

git clone https://github.com/tfrere/research-article-template.git
cd research-article-template/app
git lfs install && git lfs pull
npm install && npm run dev

License

CC-BY-4.0 - Distill-inspired, built with Astro + MDX + D3.js.

Discussions | @tfrere