Skip to content

Latest commit

 

History

History
44 lines (25 loc) · 2.3 KB

README.md

File metadata and controls

44 lines (25 loc) · 2.3 KB

IPFS Documentation

build status

IPFS Docs Beta

This repo is home to the beta version of the IPFS next-gen documentation platform, built on top of VuePress.

Want to contribute to IPFS docs?

We'd love your contributions! Right now, all open documentation issues and help-wanted items (including bounty items!) can be found in the main IPFS Documentation repo. As the beta site being iterated upon in this ipfs-docs-v2 repo comes out of beta, we'll migrate it into the main IPFS docs repo.

Working on this beta platform

As noted above, if you'd like to contribute to the IPFS docs effort as a whole, please have a look at the issues and other notes (including bounty items!) in the main IPFS Documentation repo. If you just want to spin up a local instance of this beta VuePress site, see below:

  1. Install the NPM dependencies:

    npm install
  2. Boot up the application in dev mode:

    npm start
  3. Open localhost:8080 in your browser.

Maintainers

... with thanks to the original build team: @ericronne, @dominguesgm, @jessicaschilling, @terichadbourne, and @zebateira

License

All software code is copyright (c) Protocol Labs, Inc. under the MIT license. Other written documentation and content is copyright (c) Protocol Labs, Inc. under the Creative Commons Attribution-Share-Alike License. See LICENSE file for details.