/docs

A blazing-fast documentation site generator. 📖

Primary LanguageCSS

PeerAssets official documentation repository

How to contribute:

There are two ways to contribute to PeerAssets Docs: Directly via Github website, or by running it locally. Follow the guide that better fits your needs (and knowledge).

Directly via Github:

  1. Edit any of the docs files;
  2. Submit a Pull Request with your changes.

Developing locally:

Make sure you have Node.js installed. If you don't, please follow this guide.

  1. Clone this repo: git clone https://github.com/PeerAssets/docs.git;
  2. Inside the cloned folder, run: npm i -g brunch && npm i; (skip the first command if you already have brunch installed);
  3. Run: npm start.
  4. Access http://localhost:3333/ in your browser.

Any changes in the project (both on docs and/or code) will be reflect automatically in the browser once you refresh it.

Deploying a public test version:

  1. In your local project, run: npm run deploy.
  2. Access your changes at: https://PeerAssets.github.io/docs/

Note: PeerAssets.github.io/docs/ is a test version of the docs, and thus shouldn't be shared openly as the production documentation website.