dlouapre HF Staff commited on
Commit
d833a37
·
verified ·
1 Parent(s): 8360712

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +3 -108
README.md CHANGED
@@ -1,5 +1,5 @@
1
  ---
2
- title: 'Bringing paper to life: A modern template for scientific writing'
3
  emoji: 📝
4
  colorFrom: blue
5
  colorTo: indigo
@@ -12,110 +12,5 @@ tags:
12
  - research paper
13
  - scientific paper
14
  - data visualization
15
- thumbnail: https://huggingface.co/spaces/tfrere/research-paper-template/thumb.jpg
16
- ---
17
- <div align="center">
18
-
19
- # Research Article Template
20
-
21
- [![License: CC BY 4.0](https://img.shields.io/badge/License-CC%20BY%204.0-lightgrey.svg)](https://creativecommons.org/licenses/by/4.0/)
22
- [![Node.js Version](https://img.shields.io/badge/node-%3E%3D20.0.0-brightgreen.svg)](https://nodejs.org/)
23
- [![Astro](https://img.shields.io/badge/Astro-4.10.0-orange.svg)](https://astro.build/)
24
- [![Hugging Face Spaces](https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-Spaces-blue)](https://huggingface.co/spaces/tfrere/research-article-template)
25
-
26
-
27
- **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.
28
-
29
- **[Try the live demo & documentation →](https://huggingface.co/spaces/tfrere/research-article-template)**
30
-
31
- </div>
32
-
33
- ## 🚀 Quick Start
34
-
35
- ### Option 1: Duplicate on Hugging Face (Recommended)
36
-
37
- 1. Visit **[🤗 Research Article Template](https://huggingface.co/spaces/tfrere/research-article-template)**
38
- 2. Click **"Duplicate this Space"**
39
- 3. Clone your new repository:
40
- ```bash
41
- git clone git@hf.co:spaces/<your-username>/<your-space>
42
- cd <your-space>
43
- ```
44
-
45
- ### Option 2: Clone Directly
46
-
47
- ```bash
48
- git clone https://github.com/tfrere/research-article-template.git
49
- cd research-article-template
50
- ```
51
-
52
- ### Installation
53
-
54
- ```bash
55
- # Install Node.js 20+ (use nvm for version management)
56
- nvm install 20
57
- nvm use 20
58
-
59
- # Install Git LFS and pull assets
60
- git lfs install
61
- git lfs pull
62
-
63
- # Install dependencies
64
- cd app
65
- npm install
66
-
67
- # Start development server
68
- npm run dev
69
- ```
70
-
71
- Visit `http://localhost:4321` to see your site!
72
-
73
- ## 🎯 Who This Is For
74
-
75
- - **Scientists** writing modern, web-native research papers
76
- - **Educators** creating interactive, explorable lessons
77
- - **Researchers** who want to focus on ideas, not infrastructure
78
- - **Anyone** who values clear, engaging technical communication
79
-
80
- ## 🌟 Inspired by Distill
81
-
82
- This template carries forward the spirit of [Distill](https://distill.pub/) (2016–2021), pushing interactive scientific writing even further with:
83
- - Accessible, high-quality explanations
84
- - Reproducible, production-ready demos
85
- - Modern web technologies and best practices
86
-
87
- ## 🤝 Contributing
88
-
89
- We welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.md) for details.
90
-
91
- ### Ways to Contribute
92
-
93
- - **Report bugs** - Open an issue with detailed information
94
- - **Suggest features** - Share ideas for improvements
95
- - **Improve documentation** - Help others get started
96
- - **Submit code** - Fix bugs or add features
97
- - **Join discussions** - Share feedback and ideas
98
-
99
- ## 📄 License
100
-
101
- This project is licensed under the [Creative Commons Attribution 4.0 International License](https://creativecommons.org/licenses/by/4.0/).
102
-
103
- - **Diagrams and text**: CC-BY 4.0
104
- - **Source code**: Available on [Hugging Face](https://huggingface.co/spaces/tfrere/research-article-template)
105
- - **Third-party figures**: Excluded and marked in captions
106
-
107
- ## 🙏 Acknowledgments
108
-
109
- - Inspired by [Distill](https://distill.pub/) and the interactive scientific writing movement
110
- - Built with [Astro](https://astro.build/), [MDX](https://mdxjs.com/), and modern web technologies
111
- - Community feedback and contributions from researchers worldwide
112
-
113
- ## 📞 Support
114
-
115
- - **[Community Discussions](https://huggingface.co/spaces/tfrere/research-article-template/discussions)** - Ask questions and share ideas
116
- - **[Report Issues](https://huggingface.co/spaces/tfrere/research-article-template/discussions?status=open&type=issue)** - Bug reports and feature requests
117
- - **Contact**: [@tfrere](https://huggingface.co/tfrere) on Hugging Face
118
-
119
- ---
120
-
121
- **Made with ❤️ for the scientific community**
 
1
  ---
2
+ title: 'The Eiffel Tower Llama'
3
  emoji: 📝
4
  colorFrom: blue
5
  colorTo: indigo
 
12
  - research paper
13
  - scientific paper
14
  - data visualization
15
+ thumbnail: https://dlouapre-eiffel-llama.hf.space/_astro/eiffel_tower_llama.BkstKRFB_Z1sz10B.webp
16
+ ---