Skip to content

Latest commit

 

History

History
28 lines (21 loc) · 1.44 KB

README.md

File metadata and controls

28 lines (21 loc) · 1.44 KB

Commonground Gateway

Documentation Status BCH compliance

Quick start

Documentation

Full technical documentation is provided on read the docs and is based on MKDocs. An more product owner focused (and lesd tehcnical) product page is hosted at .

If you want to run the technical documantation localy you van do so by using MKDocs build in server and the serve command. Just go to the local reposiroty and execute the fowwing command for the documenation to be available on post 8000 (make sure to instal MKDocs first)

$ mkdocs serve

The (non-)technical product page is based on gatsby and can als be published localy, jsut navigate to the repostory and then to de docs directory. (make sure to install gatsby CLI on you machine first doh)

$ cd /product-page
$ gatsby develop

Its is also posible to update the product page dicetly from the reposotry by running the pre-configures deploy command for the product-page direcotry, or

$ cd /product-page
$ npm run deploy

Updat