thibaud frere
chore(release): v0.1.0
9d8447d
raw
history blame
3.55 kB
import Sidenote from "../../components/Sidenote.astro";
<Sidenote>
Welcome to this **single‑page** research article template. It helps you publish **clear**, **modern**, and **interactive** technical writing with **minimal setup**. Grounded in up to date good practices in web dev, it favors interactive explanations, clear 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>
</Sidenote>
#### Features
<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">Table of contents</span>
<span className="tag">Mermaid diagrams</span>
<span className="tag">Plotly ready</span>
<span className="tag">D3.js ready</span>
<span className="tag">HTML embeds</span>
<span className="tag">Gradio app embeds</span>
<span className="tag">Dataviz color palettes</span>
<span className="tag">Optimized images</span>
<span className="tag">Lightweight bundle</span>
<span className="tag">SEO-friendly</span>
<span className="tag">Automatic build</span>
<span className="tag">Automatic PDF export</span>
<span className="tag">Dark theme</span>
<span className="tag">Mobile friendly</span>
</div>
<Fragment slot="aside">
If you have questions, remarks or suggestions, open a discussion on the <a href="https://huggingface.co/spaces/tfrere/research-article-template/discussions?status=open&type=discussion">Community tab</a>!
</Fragment>
</Sidenote>
## Introduction
The web enables what static PDFs can’t: **interactive diagrams**, **progressive notation**, and **exploratory views** that reveal how ideas behave. This template makes **interactive artifacts**—figures, math, code and **inspectable experiments**—first‑class alongside prose, so readers **build intuition** rather than skim results.
If you write technical blogs or research notes, you’ll benefit from a **ready‑to‑publish workflow** with clear notation, optimized media, and **automatic builds**.
### Who is this for
For people who publish web‑native, interactive writing with minimal setup:
- Researchers/engineers with live figures.
- Educators crafting explorable explanations.
Not a CMS or a multi‑page blog—this is a focused, single‑page, MDX‑first workflow.
### Inspired by Distill
<Sidenote>
This project draws strong inspiration from [**Distill**](https://distill.pub) (2016–2021), which championed clear, web‑native scholarship and set a high standard for interactive scientific communication.
To give you a sense of what inspired this template, here is a short, curated list of well‑designed and often interactive works from Distill:
- [Growing Neural Cellular Automata](https://distill.pub/2020/growing-ca/)
- [Activation Atlas](https://distill.pub/2019/activation-atlas/)
- [Handwriting with a Neural Network](https://distill.pub/2016/handwriting/)
- [The Building Blocks of Interpretability](https://distill.pub/2018/building-blocks/)
<Fragment slot="aside">
I'm always excited to discover more great examples—please share your favorites in the <a href="https://huggingface.co/spaces/tfrere/research-blog-template/discussions?status=open&type=discussion">Community tab</a>!
</Fragment>
</Sidenote>