redirectgen creates a static folder of HTML documents that serve as URL shorteners. It creates a (potentially deeply nested)
folder for every shortened URL configuration with an
index.html file which contains an HTML redirect. It can also
be configured to contain a countapi call as well to track the amount of redirects.
Install globally via
npm install -g redirectgen
or directly use via
You need a yaml configuration file that contains your links:
links: example: url: https://lukasbach.com with-count-api: url: https://lukasbach.com countapi: adfsafdsafd my/deeply/nested/link: url: https://lukasbach.com countapi: adfsafdsafd
Usage: redirectgen [options] Options: -V, --version output the version number -o, --output <path> path to output -c, --config <path> path to config yaml file -h, --help display help for command
npx redirectgen -c ./link-config.yaml -o ./output
yarnto install dependencies
yarn startto run in dev mode
yarn testto run tests
yarn lintto test and fix linter errors
To publish a new version, the publish pipeline can be manually invoked.