Skip to content
This repository has been archived by the owner on Feb 8, 2020. It is now read-only.

Latest commit

 

History

History
32 lines (22 loc) · 507 Bytes

README.md

File metadata and controls

32 lines (22 loc) · 507 Bytes
Raw

SignHash Contracts Documentation

Requirements

  • docker > 1.13.1
  • docker-compose
  • npm

Generating documentation

Documentation is generated in /dist folder.

npm install
npm start

After finishing, it is recommended to change ownership of the generated files because docker mounts the volume as root.

sudo chown -R $USER:$USER dist/ pages/ config.toml

Browsing generated docs locally

npm run serve

Documentation is available at http://localhost:5000