| --- |
| title: "Bringing paper to life:\n A modern template for\n scientific writing |
| " |
| subtitle: "A modern, MDX-first research article template with math, citations and interactive figures." |
| description: "A modern, MDX-first research article template with math, citations and interactive figures." |
| authors: |
| - "Thibaud Frere" |
| affiliation: "Hugging Face" |
| published: "Sep. 01, 2025" |
| tags: |
| - research |
| - template |
| ogImage: "/thumb.jpg" |
| --- |
|
|
| import HtmlEmbed from "../components/HtmlEmbed.astro"; |
| import Wide from "../components/Wide.astro"; |
| import FullWidth from "../components/FullWidth.astro"; |
| import { Image } from 'astro:assets'; |
| import placeholder from "./assets/images/placeholder.png"; |
| import audioDemo from "./assets/audio/audio-example.wav"; |
| import Sidenote from "../components/Sidenote.astro"; |
| import visualPoster from "./assets/images/visual-vocabulary-poster.png"; |
|
|
| import BestPractices from "./chapters/best-pratices.mdx"; |
| import WritingYourContent from "./chapters/writing-your-content.mdx"; |
| import AvailableBlocks from "./chapters/available-blocks.mdx"; |
| import GettingStarted from "./chapters/getting-started.mdx"; |
|
|
| <Sidenote> |
| Welcome to this single‑page **research article template**. It helps you publish **clear**, **modern**, and **interactive technical writing** with **minimal setup**. Grounded in **web‑native scholarship**, it favors **interactive explanations**, careful notation, and **inspectable examples** over static snapshots. |
| |
| It offers a **ready‑to‑publish, all‑in‑one workflow** so you can **focus on ideas** rather than infrastructure. |
| <Fragment slot="aside"> |
| Reading time: 20–25 minutes. |
| </Fragment> |
| Use it as a **practical baseline**: **start simple**, **iterate** on structure and style, and keep content **maintainable** for future readers and collaborators. |
| |
| </Sidenote> |
|
|
|
|
| |
|
|
| <Sidenote> |
| <div className="tag-list"> |
| <span className="tag">Markdown based</span> |
| <span className="tag">KaTeX math</span> |
| <span className="tag">Syntax highlighting</span> |
| <span className="tag">Citations & footnotes</span> |
| <span className="tag">Automatic build</span> |
| <span className="tag">Table of content</span> |
| <span className="tag">Dark theme</span> |
| <span className="tag">HTML fragments</span> |
| <span className="tag">Plotly ready</span> |
| <span className="tag">D3.js ready</span> |
| <span className="tag">SEO Friendly</span> |
| <span className="tag">Mermaid diagrams</span> |
| <span className="tag">Lightweight bundle</span> |
| <span className="tag">Mobile friendly</span> |
| <span className="tag">Optimized images</span> |
| <span className="tag">Automatic PDF export</span> |
| <span className="tag">Dataviz color palettes</span> |
| <span className="tag">Embed gradio apps</span> |
| </div> |
| <Fragment slot="aside"> |
| If you have questions or remarks open a discussion on the <a href="https://huggingface.co/spaces/tfrere/research-blog-template/discussions?status=open&type=discussion">Community tab</a>! |
| </Fragment> |
| </Sidenote> |
|
|
| |
| The web affords explanations that static PDFs cannot: **reactive diagrams**, progressive notation, and exploratory views that reveal how ideas behave. Use **interactive fragments** so readers can hover, scrub, and inspect—building **intuition** rather than merely reading results. |
|
|
| Precise notation, thoughtful visual encodings, and small, **manipulable experiments** deepen understanding. Treat these artifacts as **first‑class** alongside text, math, and code to help readers grasp mechanisms, limits, and trade‑offs. |
|
|
| Not every contribution fits a PDF. Treat demos, visualizations, and interactive write‑ups as scholarship: cite and version them, and ship clear, inspectable examples that expose intermediate states and link to sources so readers can verify and reproduce results. |
|
|
| This project is heavily inspired by [**Distill**](https://distill.pub) (2016–2021), which championed clear, web‑native scholarship. |
| |
| {/* |
| |
| A short, curated list of well‑designed and often interactive work: |
| |
| - **Distill — The Building Blocks of Interpretability**: [distill.pub/2018/building-blocks](https://distill.pub/2018/building-blocks/) |
| - **R2D3 — A Visual Introduction to Machine Learning (Part 1)**: [r2d3.us/visual-intro-to-machine-learning-part-1](http://www.r2d3.us/visual-intro-to-machine-learning-part-1/) |
| - **Seeing Theory — An interactive introduction to probability and statistics**: [seeing-theory.brown.edu](https://seeing-theory.brown.edu/) |
| - **ConvNetJS — Neural networks in the browser**: [cs.stanford.edu/people/karpathy/convnetjs](http://cs.stanford.edu/people/karpathy/convnetjs/) |
| - **Explorable Explanations — Collection**: [explorableexplanations.com](http://explorableexplanations.com/) |
| - **Distill — Why Momentum Really Works**: [distill.pub/2017/momentum](https://distill.pub/2017/momentum/) |
| */} |
|
|
| <GettingStarted /> |
|
|
| <WritingYourContent /> |
|
|
| <AvailableBlocks /> |
|
|
| <BestPractices /> |
|
|
|
|