Effortlessly turn any arXiv paper into a stylish GitHub Pages website.

---

✨ Features

• 🔍 Auto-fetches metadata (title, authors, abstract) from an arXiv paper
• 🌐 Instantly generates a stylish website using Jekyll templates
• 🎨 Supports customizable themes
• 📦 One-liner install and run

🚀 Installation

Install ArxSite from PyPI:

pip install arxsite

🛠️ Usage

arxsite <arxiv_url> [--style <style_name>]

Options:
  --style, -s     Choose a website style (default: default)
  --help, -h      Show this help message and exit

🖼️ Available Website Styles

Click to view styles

1. default

A simple template, rushed by Rong.

2. Your Style (Coming Soon?)

Your custom style is always welcome! Feel free to contribute your own template and tell us a fun fact about yourself, your theme, or your design process.

⚡ Quick Guide

Click to view guides

1. Navigate to your GitHub project root folder

cd <Your GitHub Project Root>

2. Create and switch to a new empty branch called website

git checkout --orphan website
git rm -rf .  # Remove all tracked files from index

3. Run arxsite with your arXiv paper URL

arxsite https://arxiv.org/abs/2501.18630

📦 Sample Output:

🔍 Fetching metadata from: https://arxiv.org/abs/2501.18630
title: Deformable Beta Splatting
authors: Rong Liu, Dylan Sun, Meida Chen, Yue Wang, Andrew Feng
🛠️ Generating Jekyll site with style 'default'...
🌐 Jekyll site generated at: test_path
✅ Website generated successfully!

4. Add, commit, and push the website branch

git add .
git commit -m "Initialize website from arxsite"
git push origin website

5. Set up GitHub Pages from the website branch

Go to Settings > Pages and select the website branch as the source.

6. 🎉 Visit your project website!

https://<Your GitHub Username>.github.io/<Repo Name>/

✅ Example: https://rongliu-leo.github.io/ArxSite/

🙌 Contribute

Have a cool idea or style in mind?
Pull requests are welcome! Help make ArxSite better for everyone.