README
Research Article Template
A modern, interactive template for scientific writing that brings papers to life.
Interactive diagrams, math, citations, dark mode, PDF export - all with minimal setup.
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:
paper(formal, with banner, TOC, citations, figure numbering) orarticle(lighter centered layout, no banner, no figure numbering) - 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: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:
| Value | Layout | Best for |
|---|---|---|
paper (default) | Banner, sidebar TOC, figure numbering, citation block, PDF export | Formal research papers |
article | Centered single column, no banner, no figure numbering, minimal footer | Blog posts, lighter articles |
Edit your content
| 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 |
Commands
| 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 |
Alternative setup
Duplicate on Hugging Face
- Visit Research Article Template, click "Duplicate this Space"
- Clone:
git clone git@hf.co: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 dev
License
CC-BY-4.0 - Distill-inspired, built with Astro + MDX + D3.js.
Similar repos
README
Research Article Template
A modern, interactive template for scientific writing that brings papers to life.
Interactive diagrams, math, citations, dark mode, PDF export - all with minimal setup.
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:
paper(formal, with banner, TOC, citations, figure numbering) orarticle(lighter centered layout, no banner, no figure numbering) - 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: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:
| Value | Layout | Best for |
|---|---|---|
paper (default) | Banner, sidebar TOC, figure numbering, citation block, PDF export | Formal research papers |
article | Centered single column, no banner, no figure numbering, minimal footer | Blog posts, lighter articles |
Edit your content
| 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 |
Commands
| 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 |
Alternative setup
Duplicate on Hugging Face
- Visit Research Article Template, click "Duplicate this Space"
- Clone:
git clone git@hf.co: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 dev
License
CC-BY-4.0 - Distill-inspired, built with Astro + MDX + D3.js.