Skip to content

GeminiLight/OverLink

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

204 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

OverLink Logo

OverLink

Turn your Overleaf projects into persistent PDF URLs.
Seamlessly synchronize your Overleaf projects with your personal website/portfolio.

🇺🇸 English | 🇨🇳 中文

Star on GitHub Tweet

License: MIT Status PRs Welcome

FeaturesHow It WorksGetting StartedContributing


📖 Introduction

OverLink acts as the automated bridge between your research and your audience. It solves the tedious problem of manually exporting, renaming, and uploading your CV or papers every time you fix a typo or add a citation.

Why OverLink?

🚫 The Manual Struggle ✅ The OverLink Flow

Tedious:
Download PDF -> Rename -> Upload via FTP/Git

Outdated:
"Last updated: 2023" (because you forgot)

Fragile:
Broken links if you change filenames

🟢 Automated:
Detects changes & deploys instantly

🟢 Always Fresh:
Your site always shows the latest compile

🟢 Reliable:
Stable URLs, optimized delivery

⚡ Use Case: Always-Current CV

Link it once, update it forever.

Instead of uploading CV_Final_v2_REALLY_FINAL.pdf every time you fix a typo, just use your stable OverLink URL on your personal website:

<!-- Your portfolio website -->
<a href="https://blob.overlink.aurax.live/output.pdf" target="_blank">
  📄 Download My CV
</a>

When you recompile in Overleaf, your website updates automatically.

✨ Features

🔄 Automatic Sync 🛡️ Secure ☁️ Dual Modes
Never drag-and-drop a PDF again. Changes in Overleaf are detected and deployed instantly. No required credentials—just use your shared project IDs. Your account stays safe. Choose between our fully managed Cloud SaaS or self-host strictly on your own hardware.

🛠️ How It Works

👩‍💻 User Pushes     📄 Overleaf Compiles     🤖 OverLink Syncs     🌐 Website Updates


Step Action
1. Detect OverLink watches your Overleaf project for changes.
2. Capture Uses a headless browser to generate a pixel-perfect PDF.
3. Deploy Uploads the optimized asset to your Cloud Storage or Git Repo.

🏗️ Architecture

Component Description Access
☁️ OverLink Cloud (Managed) The easiest way to get started. No infrastructure to manage. Visit overlink.aurax.live
💻 OverLink Local (Self-Hosted) CLI tool/Worker for your own machine or CI/CD. Local Setup Guide
📦 Core Shared libraries and browser automation logic. Source Code

🚀 Getting Started

Option A: OverLink Cloud (Recommended)

The professional, zero-config experience.

  1. Visit overlink.aurax.live.
  2. Connect your Overleaf account.
  3. Start syncing your academic assets instantly.
Option B: OverLink Local (Self-Hosted)

For power users who want full control.

  1. View the detailed guide:

  2. Quick Start:

    cd apps/local
    chmod +x start.sh
    ./start.sh

📈 Star History

If you find OverLink detailed or useful, please consider giving it a star! It helps us grow.

Star History Chart

🤝 Contributing

We welcome contributions! Whether it's reporting a bug, suggesting a feature, or writing code, your help is appreciated.

  1. Fork the repository.
  2. Create your feature branch (git checkout -b feature/AmazingFeature).
  3. Commit your changes (git commit -m 'Add some AmazingFeature').
  4. Push to the branch (git push origin feature/AmazingFeature).
  5. Open a Pull Request.

📄 License

Distributed under the MIT License. See LICENSE for more information.


Built with ❤️ by GeminiLight

About

Turn your Overleaf projects into persistent PDF URLs. Seamlessly synchronize your Overleaf projects with your personal website/portfolio.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors