simple-url-shortener
Advanced tools
simple-url-shortener is a simple tool that build shorten urls for GitHub page without magic.
Here are steps:
{
"home": "https://liaoxuefeng.com",
"BTC": "https://bitcoin.org"
}
The case-sensitive key is composed by 1 ~ 6 characters of a ~ z, A ~ Z and 0 ~ 9.
Create GitHub action build.yml (just copy the content and change the branch name if neccessary).
Set GitHub pages:
You can then access shorten URL like https://redirect.liaoxuefeng.com/BTC after build.
You can find the example repo.
The urls.json contains key - url mapping. simple-url-shortener will generate HTML files for each shorten URL. The generated GitHub pages structure:
_site/
├── 404.html
├── index.html
├── BTC
│ └── index.html
└── home
└── index.html
The HTML file uses <meta http-equiv="refresh" content="0;URL=xxx"/> for redirect:
$ curl https://redirect.liaoxuefeng.com/BTC/index.html
<html>
<head>
<meta http-equiv="refresh" content="0;URL='https://bitcoin.org/'" />
...
You can also set a config.json for configuration:
{
"wait": 0, // auto redirect in seconds, 0 = immediately, n = display link and wait for n seconds, -1 = display link only.
"generate404": true, // generate a 404 page, default to true.
"generateIndex": true // generate an index page, default to true.
}
If you want to use your own designed template to generate pages, copy the following template files to your repo's root dir and make some change:
FAQs
A simple URL shortener without magic.
The npm package simple-url-shortener receives a total of 0 weekly downloads. As such, simple-url-shortener popularity was classified as not popular.
We found that simple-url-shortener demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Following last week’s supply chain attack, Nx published findings on the GitHub Actions exploit and moved npm publishing to Trusted Publishers.
Security News
AGENTS.md is a fast-growing open format giving AI coding agents a shared, predictable way to understand project setup, style, and workflows.
Security News
/Research
Malicious npm package impersonates Nodemailer and drains wallets by hijacking crypto transactions across multiple blockchains.