https://github.com/axorax/rover
Static site generator but for redirects
https://github.com/axorax/rover
links redirect redirection redirects rover ssg
Last synced: 17 days ago
JSON representation
Static site generator but for redirects
- Host: GitHub
- URL: https://github.com/axorax/rover
- Owner: Axorax
- License: agpl-3.0
- Created: 2024-12-14T10:21:49.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-28T11:07:08.000Z (over 1 year ago)
- Last Synced: 2025-10-31T03:42:49.992Z (9 months ago)
- Topics: links, redirect, redirection, redirects, rover, ssg
- Language: Python
- Homepage:
- Size: 69.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
## 🌐 Rover
Static site generator but for redirects.
Rover allows you to generate HTML pages that redirect to other URLs in one config file using the custom Rover syntax. It can be used as an URL shortener or anything.
If you have a static site and want to create redirect links, instead of making them all manually, you can use Rover. Rover can also visualize all of your links.
## ✨ Features
- Custom syntax that is easy and well-documented. [🔗 Documentation](./FILE%20FORMAT.md)
- Supports metadata.
- Visualize all of your configurations.
- Automatically makes text URL friendly
- Supports multiple methods to redirect.
## ❓ Why use Rover?
Using Rover is faster than writing HTML pages for redirects manually. All links are stored in one easy to edit config file. You can also add metadata.
## 🔥 What's the syntax like?
Full documentation => [🔗 Click here](./FILE%20FORMAT.md)
Full example configuration => [🔗 Click here](./example.rvr)
```js
method = both # [both | js | html]
[redirects]
youtube = https://youtube.com
[
title = YouTube Link
keywords = YouTube, video, sharing
description = Video sharing site
]
axorax = https://axorax.github.io
```
## 💻 CLI Commands
Example usage:
```sh
python main.py config.rvr -o rover -v true
```
All commands:
```sh
>> python main.py -h
usage: main.py [-h] [-oj JSON_FILE] [-ov HTML_FILE] [-v TRUE | FALSE]
[-j TRUE | FALSE] [-m TRUE | FALSE] [-o FOLDER_NAME]
[-me METHOD_NAME]
CONFIG
Generate redirect HTML files based on a configuration file.
positional arguments:
CONFIG Path to the configuration file (e.g., config.rvr)
options:
-h, --help show this help message and exit
-oj, --output-json JSON_FILE
Specify the output JSON file name (default: output.json)
-ov, --output-visualizer HTML_FILE
Specify the visualizer output file name (default:
rover.html)
-v, --visualize TRUE | FALSE
Visualize the configuation file (default: false)
-j, --json TRUE | FALSE
Generate JSON output (default: false)
-m, --minify TRUE | FALSE
Minify the HTML files (default: false)
-o, --output FOLDER_NAME
Output folder name (default: rover)
-me, --method METHOD_NAME
Redirection method (default: both)
```
---