shortlinks

A simple, easily manageable, shortlinks solution using Jekyll and GitHub Pages

Preview

Visit go.rambots.org to see a live preview of this repository.

Setup

To use shortlinks for yourself, you can download this repository as a ZIP file, or clone it using Git.

git clone https://github.com/frc2204/shortlinks.git

Configuration

Under the _config.yml file, you can change the following settings:

name: Shortlinks # Name it whatever you want
description: A simple, easily manageable, shortlinks solution using Jekyll and GitHub Pages # Describe your site

GitHub Pages

To host your shortlinks on GitHub Pages, you must enable it in the repository settings.

For more information regarding GitHub Pages, visit pages.github.com.

The GitHub action included with this repository will automatically build and deploy your shortlinks to GitHub Pages. If you do not want to use GitHub Pages, you can disable the action by removing the .github/workflows/gh-pages.yml file.

Managing Shortlinks

To add a shortlink, simply add a new file ending with .html or .md to the _shortlinks directory.

The file should contain the following information (front matter):

---
name: Example Shortlink # The name of the shortlink (optional)
description: An example shortlink # The description of the shortlink (optional)
target: https://example.com # The URL to redirect to
permalink: /example-shortlink/ # The shortened link (relative path)
---

Note: The actual filename does not matter, but it is recommended to use the same name as the permalink.

Deletion is pretty straightforward, just delete the file from the _shortlinks directory.