|
|
--- |
|
|
title: 'Maintain the unmaintainable' |
|
|
emoji: 📚 |
|
|
colorFrom: blue |
|
|
colorTo: indigo |
|
|
sdk: docker |
|
|
pinned: false |
|
|
header: mini |
|
|
app_port: 8080 |
|
|
tags: |
|
|
- research-article-template |
|
|
- research paper |
|
|
- scientific paper |
|
|
- data visualization |
|
|
thumbnail: https://huggingface.co/spaces/tfrere/research-paper-template/thumb.jpg |
|
|
--- |
|
|
<div align="center"> |
|
|
|
|
|
# Research Article Template |
|
|
|
|
|
[](https://creativecommons.org/licenses/by/4.0/) |
|
|
[](https://nodejs.org/) |
|
|
[](https://astro.build/) |
|
|
[](https://huggingface.co/spaces/tfrere/research-article-template) |
|
|
|
|
|
|
|
|
**A modern, interactive template for scientific writing** that brings papers to life with web-native features. The web offers what static PDFs can't: **interactive diagrams**, **progressive notation**, and **exploratory views** that show how ideas behave. This template treats interactive artifacts—figures, math, code, and inspectable experiments—as **first-class** alongside prose, helping readers **build intuition** instead of skimming results—all with **minimal setup** and no web knowledge required. |
|
|
|
|
|
**[Try the live demo & documentation →](https://huggingface.co/spaces/tfrere/research-article-template)** |
|
|
|
|
|
</div> |
|
|
|
|
|
## 🚀 Quick Start |
|
|
|
|
|
### Option 1: Duplicate on Hugging Face (Recommended) |
|
|
|
|
|
1. Visit **[🤗 Research Article Template](https://huggingface.co/spaces/tfrere/research-article-template)** |
|
|
2. Click **"Duplicate this Space"** |
|
|
3. Clone your new repository: |
|
|
```bash |
|
|
git clone git@hf.co:spaces/<your-username>/<your-space> |
|
|
cd <your-space> |
|
|
``` |
|
|
|
|
|
### Option 2: Clone Directly |
|
|
|
|
|
```bash |
|
|
git clone https://github.com/tfrere/research-article-template.git |
|
|
cd research-article-template |
|
|
``` |
|
|
|
|
|
### Installation |
|
|
|
|
|
```bash |
|
|
# Install Node.js 20+ (use nvm for version management) |
|
|
nvm install 20 |
|
|
nvm use 20 |
|
|
|
|
|
# Install Git LFS and pull assets |
|
|
git lfs install |
|
|
git lfs pull |
|
|
|
|
|
# Install dependencies |
|
|
cd app |
|
|
npm install |
|
|
|
|
|
# Start development server |
|
|
npm run dev |
|
|
``` |
|
|
|
|
|
Visit `http://localhost:4321` to see your site! |
|
|
|
|
|
## 🎯 Who This Is For |
|
|
|
|
|
- **Scientists** writing modern, web-native research papers |
|
|
- **Educators** creating interactive, explorable lessons |
|
|
- **Researchers** who want to focus on ideas, not infrastructure |
|
|
- **Anyone** who values clear, engaging technical communication |
|
|
|
|
|
## 🌟 Inspired by Distill |
|
|
|
|
|
This template carries forward the spirit of [Distill](https://distill.pub/) (2016–2021), pushing interactive scientific writing even further with: |
|
|
- Accessible, high-quality explanations |
|
|
- Reproducible, production-ready demos |
|
|
- Modern web technologies and best practices |
|
|
|
|
|
## 🤝 Contributing |
|
|
|
|
|
We welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.md) for details. |
|
|
|
|
|
### Ways to Contribute |
|
|
|
|
|
- **Report bugs** - Open an issue with detailed information |
|
|
- **Suggest features** - Share ideas for improvements |
|
|
- **Improve documentation** - Help others get started |
|
|
- **Submit code** - Fix bugs or add features |
|
|
- **Join discussions** - Share feedback and ideas |
|
|
|
|
|
## 📄 License |
|
|
|
|
|
This project is licensed under the [Creative Commons Attribution 4.0 International License](https://creativecommons.org/licenses/by/4.0/). |
|
|
|
|
|
- **Diagrams and text**: CC-BY 4.0 |
|
|
- **Source code**: Available on [Hugging Face](https://huggingface.co/spaces/tfrere/research-article-template) |
|
|
- **Third-party figures**: Excluded and marked in captions |
|
|
|
|
|
## 🙏 Acknowledgments |
|
|
|
|
|
- Inspired by [Distill](https://distill.pub/) and the interactive scientific writing movement |
|
|
- Built with [Astro](https://astro.build/), [MDX](https://mdxjs.com/), and modern web technologies |
|
|
- Community feedback and contributions from researchers worldwide |
|
|
|
|
|
## 📞 Support |
|
|
|
|
|
- **[Community Discussions](https://huggingface.co/spaces/tfrere/research-article-template/discussions)** - Ask questions and share ideas |
|
|
- **[Report Issues](https://huggingface.co/spaces/tfrere/research-article-template/discussions?status=open&type=issue)** - Bug reports and feature requests |
|
|
- **Contact**: [@tfrere](https://huggingface.co/tfrere) on Hugging Face |
|
|
|
|
|
--- |
|
|
|
|
|
**Made with ❤️ for the scientific community** |
|
|
|
