Skip to content
This repository has been archived by the owner on Aug 22, 2024. It is now read-only.

Latest commit

 

History

History
49 lines (37 loc) · 1.4 KB

README.md

File metadata and controls

49 lines (37 loc) · 1.4 KB

Introduction

This is a plain HTML static URL shortener built with Jekyll. I give more details in this blog post.

How to use it

Preparation

  1. Get your own domain name: domain.tld.
  2. Fork the repo.
  3. Update CNAME with your domain name.
  4. Update _config.yaml with your information.
  5. Update index.md with your information.
  6. Enable github pages for the repo.

Shorten URLs

  1. Let's say you want to shorten: https://sub.other-domain.com/2021/01/article.html.
  2. Let's say you want it to be domain.tld/article.
  3. Create an HTML file under _URLs named as the permalink: Here article.html.
  4. The content of this HTML page is:
---
layout: redirect
# Time in seconds before the redirect.
time: '0'
# The target of the redirect.
target: "https://sub.other-domain/2021/01/article.html"
---
  1. git add, commit, push.
  2. Visit domain.tld/article and you'll be redirected.

Features

  • ✅ Plain HTML URL shortener

  • ✅ Lightweight

  • ✅ Faaaaast

  • ✅ Free to host on github.com

  • ❎ No CSS, No JS

  • ❎ No database

  • ❎ No webserver

  • ❎ No loadbalancing

  • ❎ No analytics

  • ❎ Blockchain and AI free