4 releases

0.1.3 Jan 11, 2023
0.1.2 Jan 9, 2023
0.1.1 Jan 9, 2023
0.1.0 Jan 9, 2023

#32 in Value formatting

Download history 102/week @ 2023-01-07 11/week @ 2023-01-14 9/week @ 2023-01-21

122 downloads per month

MIT license

7KB
137 lines

Mubo, a static url shortener generator

Mubo allows you to host your own static url shortener on GitHub Pages (or Netlify, Vercel, GitLab Pages, ...) by populating a config.toml file.

Getting started

To add a new link, append the following values to your config.toml file:

[[links]]
key = "otso"
url = "https://otso.fr"

The key represents the slug that will be used to redirect to the url.

Build the static site

Run the mubo command within the root directory of your project where lies the config.toml file.

It will generate all the pages and subdirectories under the r directory.

Use the url shortener

If we take the example above, you will need to go to the YOUR_BASE_URL/r/otso to be redirected to https://otso.fr

Live example

To see a live example of this script, you can have a look at my own url shortener.

Did you know ?

mubo means 'short' in Cebunao

Dependencies

~0.9–1.6MB
~36K SLoC