JSPM

all-relative

2.0.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 67
  • Score
    100M100P100Q70276F
  • License MIT

a work in progress command line tool to convert a static site to use only relative urls, so it can be deployed to ipfs.

Package Exports

  • all-relative

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (all-relative) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

all-relative

A command line tool to convert a static site to use only relative urls.

Run it from the the directory which contains your generated static site to have it convert all urls in html and css to be relative to that dir.

It leaves you with a portable website that doesn't care what path it is mounted at. /, /olizilla/ /ipfs/hash/, file://x/y/z/, the lot, it don't care. This allows you to load the same static site via IPFS or github pages, or the localfile system, as well as from the root of your custom domain. Relative urls are wonderful.

The command will edit the files in place, so it's best to run it on generated output that you can recreate if you need to. If you can't, be sure to take a back up of your site first.

✨🎷🐩

Install

Install it with

$ npm install -g all-relative

or run just it wihtout installing it via npx

$ npx all-relative

Usage

Run the command from the root directory of your static site.

$ all-relative