Transformers-tenets / README.md
Molbap's picture
Molbap HF Staff
push a bunch of updates
e903a32
|
raw
history blame
4.36 kB
metadata
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

Research Article Template

License: CC BY 4.0 Node.js Version Astro Hugging Face Spaces

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 β†’

πŸš€ Quick Start

Option 1: Duplicate on Hugging Face (Recommended)

  1. Visit πŸ€— Research Article Template
  2. Click "Duplicate this Space"
  3. Clone your new repository:
    git clone git@hf.co:spaces/<your-username>/<your-space>
    cd <your-space>
    

Option 2: Clone Directly

git clone https://github.com/tfrere/research-article-template.git
cd research-article-template

Installation

# 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 (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 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.

  • Diagrams and text: CC-BY 4.0
  • Source code: Available on Hugging Face
  • Third-party figures: Excluded and marked in captions

πŸ™ Acknowledgments

  • Inspired by Distill and the interactive scientific writing movement
  • Built with Astro, MDX, and modern web technologies
  • Community feedback and contributions from researchers worldwide

πŸ“ž Support


Made with ❀️ for the scientific community