Skip to content

Intermesh/goui-docs

Repository files navigation

Group-Office User Interface documentation

This repository holds the source code for the GOUI documentation website.

How to install locally

If you wish to contribute to the documentation of GOUI, please follow the instructions below. For the sake of completeness, it is assumed that the goui-docs repository is installed in ~/src/goui-docs.

  • Go to the GOUI docs repository cd ~/src/goui-docs
  • Install npm dependencies: npm install
  • Start the documentation site: npm start
  • Open http://localhost:8081/ in the browser.
  • You can also just build the site by running: npm run build

Now, you have a local running version of the GOUI documentation. Happy documenting!