This repo is home to the beta version of the IPFS next-gen documentation platform, built on top of VuePress.
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.
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:
-
Install the NPM dependencies:
npm install
-
Boot up the application in dev mode:
npm start
-
Open localhost:8080 in your browser.
Any issues found within this repo should be listed in the ipfs/docs issues tracker. This repository will be merged into the ipfs/docs repository in quarter 2 of 2020. Having all the issues in one place will help to keep things organized. It also enables us to retain the commit history of ipfs/docs. Once the merge is complete, this repository will be archived.
... with thanks to the original build team: @ericronne, @dominguesgm, @jessicaschilling, @terichadbourne, and @zebateira
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.