Name: libp2p-website
Owner: TABLEFLIP
Description: Webpage of the libp2p project. A multi protocol approach for a interoperable network stack that follows the 'self description' in favor of assumptions
Forked from: libp2p/website
Created: 2017-06-12 11:16:30.0
Updated: 2017-06-12 11:16:59.0
Pushed: 2017-08-18 08:40:43.0
Homepage: https://libp2p.io
Size: 18972
Language: CSS
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
Official website for libp2p http://libp2p.io
This repository contains the source code for the libp2p website available at http://libp2p.io
This project builds out a static site to explain libp2p, ready for deployment on ipfs. It uses hugo
to glue the html together. It provides an informative, public-facing website. The most important things are the words, concepts and links it presents.
Much of the site content is data-driven, take a look at the data
dir where find the data behind the implementations and bundles information as json.
clone https://github.com/libp2p/website
To deploy the site libp2p.io, run:
ild out the optimised site to ./public, where you can check it locally.
d the site to your local ipfs, you can check it via /ipfs/<hash>
deploy
ve your dnsimple api token as auth.token
"<api token here>" > auth.token
date the dns record for libp2p to point to the new ipfs hash.
publish-to-domain
The following commands are available:
make
Build the optimised site to the ./public
dir
make serve
Preview the production ready site at http://localhost:1313 (requires hugo
on your PATH
)
make dev
Start a hot-reloading dev server on http://localhost:1313 (requires hugo
on your PATH
)
make minfy
Optimise all the things!
make deploy
Build the site in the public
dir and add to ipfs
(requires hugo
& ipfs
on your PATH
)
make publish-to-domain
:rocket:Update the DNS record for libp2p.io
. (requires an auto.token
file to be saved in the project root.)
If you'd like to update the dnslink TXT record for another domain, pass DOMAIN=<your domain here>
like so:
publish-to-domain DOMAIN=tableflip.io
See the Makefile
for the full list or run make help
in the project root. You can pass the env var DEBUG=true
to increase the verbosity of your chosen command.
hugo
to build websiteNode.js
and npm
for build toolsipfs
to deploy changesjq
, curl
and an auth.token
file in the project root containing your dnsimple api token to update the dns.All other dependencies are pulled from npm
and the Makefile will run npm install
for you because it's nice like that.
Please do! Check out the issues, or open a PR!
Check out our notes on contributing for more information on how we work, and about contributing in general. Please be aware that all interactions related to libp2p are subject to the IPFS Code of Conduct.
Small note: If editing the README, please conform to the standard-readme specification.