https://github.com/moxystudio/gatsby-plugin-ipfs
Adds support for deploying Gatsby to IPFS by ensuring that assets are relative
https://github.com/moxystudio/gatsby-plugin-ipfs
build gatsby gatsby-plugin ipfs relative
Last synced: 8 months ago
JSON representation
Adds support for deploying Gatsby to IPFS by ensuring that assets are relative
- Host: GitHub
- URL: https://github.com/moxystudio/gatsby-plugin-ipfs
- Owner: moxystudio
- License: mit
- Created: 2018-07-28T08:00:20.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-24T21:17:26.000Z (almost 3 years ago)
- Last Synced: 2025-03-30T10:08:02.753Z (8 months ago)
- Topics: build, gatsby, gatsby-plugin, ipfs, relative
- Language: JavaScript
- Size: 628 KB
- Stars: 115
- Watchers: 10
- Forks: 37
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ipfs - gatsby-plugin-ipfs - Adds support for deploying Gatsby websites to IPFS by ensuring that assets are relative. (Tools)
- awesome-ipfs-cn - gatsby-plugin-ipfs - 通过确保资产是相对的，增加了对将盖茨比网站部署到 IPFS 的支持. (工具)
README
# gatsby-plugin-ipfs
[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Dependency status][david-dm-image]][david-dm-url] [![Dev Dependency status][david-dm-dev-image]][david-dm-dev-url]
[npm-url]:https://npmjs.org/package/gatsby-plugin-ipfs
[npm-image]:https://img.shields.io/npm/v/gatsby-plugin-ipfs.svg
[downloads-image]:https://img.shields.io/npm/dm/gatsby-plugin-ipfs.svg
[david-dm-url]:https://david-dm.org/moxystudio/gatsby-plugin-ipfs
[david-dm-image]:https://img.shields.io/david/moxystudio/gatsby-plugin-ipfs.svg
[david-dm-dev-url]:https://david-dm.org/moxystudio/gatsby-plugin-ipfs?type=dev
[david-dm-dev-image]:https://img.shields.io/david/dev/moxystudio/gatsby-plugin-ipfs.svg
Adds support for deploying [Gatsby](https://www.gatsbyjs.org/) websites to [IPFS](https://ipfs.io/) by ensuring that assets are relative.
## Installation
```sh
$ npm install --save gatsby-plugin-ipfs
```
## Usage
Set `prefixPath` to `__GATSBY_IPFS_PATH_PREFIX__` and include the plugin in your `gatsby-config.js` file:
```js
module.exports = {
pathPrefix: '__GATSBY_IPFS_PATH_PREFIX__',
plugins: [
'gatsby-plugin-ipfs',
],
};
```
And now, simply build the project with `npm run build -- --prefix-paths`. Better yet, set it by default in your `package.json`:
```json
"scripts": {
"build": "gatsby build --prefix-paths"
},
```
## But how?
It turns out the Gatsby doesn't support relative paths. But I didn't gave up and came up with smart and ugly hacks to do so:
- Adds a post-build step that iterates over files and transforms every `__GATSBY_IPFS_PATH_PREFIX__` occurrence
- Adds a very small code snippet to every HTML page that defines the `__GATSBY_IPFS_PATH_PREFIX__` global based on the browser location
## License
[MIT License](http://opensource.org/licenses/MIT)