| title | Bringing paper to life: A modern template for scientific writing | ||||
|---|---|---|---|---|---|
| short_desc | A practical journey behind training SOTA LLMs | ||||
| emoji | 📝 | ||||
| colorFrom | blue | ||||
| colorTo | indigo | ||||
| sdk | docker | ||||
| pinned | false | ||||
| header | mini | ||||
| app_port | 8080 | ||||
| tags |
|
||||
| thumbnail | https://tfrere-research-article-template.hf.space/thumb.auto.jpg |
A modern, interactive template for scientific writing that brings papers to life.
Interactive diagrams, math, citations, dark mode, PDF export - all with minimal setup.
npx create-research-article my-paperThe 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) orpaper(lighter centered single-column layout) - Hugging Face deployment (optional, auto-creates a Space if
huggingface-cliis installed)
Then start writing:
cd my-paper/app
npm run dev # dev server at localhost:4321If you skipped the auto-deploy during setup, push manually:
# create a Docker Space at huggingface.co/new-space, then:
git remote add space [email protected]:spaces/<your-username>/<your-space>
git push space mainThe project ships with Dockerfile, nginx config, and HF Space metadata ready to go.
Set template in app/src/content/article.mdx frontmatter:
| Value | Layout | Best for |
|---|---|---|
article (default) |
Banner, sidebar TOC, figure numbering, citation block, PDF export | Full research articles |
paper |
Centered single column, no figure numbering, minimal footer | Blog posts, lighter papers |
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/..."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.
| File | What |
|---|---|
app/src/content/article.mdx |
Main article (metadata + chapter imports) |
app/src/content/chapters/ |
Chapters (one .mdx per section) |
app/src/content/bibliography.bib |
BibTeX references |
app/src/content/embeds/ |
D3.js HTML visualizations |
app/src/content/assets/image/ |
Images |
app/src/content/assets/data/ |
CSV/JSON data files |
| Command | What |
|---|---|
npm run dev |
Dev server |
npm run build |
Production build |
npm run export:pdf |
Export as PDF |
npm run export:latex |
Export as LaTeX |
npm run sync:template |
Pull latest template updates |
Duplicate on Hugging Face
- Visit Research Article Template, click "Duplicate this Space"
- Clone:
git clone [email protected]:spaces/<your-username>/<your-space> cd <your-space>/app && git lfs pull && npm install && npm run dev
Clone directly
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 devCC-BY-4.0 - Distill-inspired, built with Astro + MDX + D3.js.