opencloud/docs/ocis/development/building-docs.md

title, date, weight, geekdocRepo, geekdocEditPath, geekdocFilePath

title	date	weight	geekdocRepo	geekdocEditPath	geekdocFilePath
Build the documentation	2020-07-27T08:39:38+00:00	99	https://github.com/owncloud/ocis	edit/master/docs/ocis/development	building-docs.md

Buildling the documentation

Following steps can be applied for every oCIS extension repository.

Setting up

• Install hugo
• Run make docs

Viewing the documentation

To view the rendered docs in the browser run:

cd hugo
hugo -D server

Then open "http://localhost:1313/"

When making changes to the docs, run

rsync -ax --delete ../docs/ content/

in the hugo folder and the server will pick up the changes and reload the page automatically.

Deploying the documentation

The documentation is automatically deployed from the master branch to https://owncloud.github.io