Add docs how to work with hugo

This commit is contained in:
Lukas Hirt
2020-07-27 10:43:34 +02:00
parent 8fc1f44305
commit 65baac45d0

36
docs/building-docs.md Normal file
View File

@@ -0,0 +1,36 @@
---
title: "Building the documentation"
date: 2020-07-27T08:39:38+00:00
weight: 99
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs
geekdocFilePath: building-docs.md
---
{{< toc >}}
## Buildling the documentation
Following steps can be applied for every oCIS extension repository.
### Setting up
- Install [hugo](https://gohugo.io/getting-started/installing/)
- Run `make docs`
### Viewing the documentation
To view the rendered docs in the browser run:
```bash
cd hugo
hugo -D server
```
Then open "http://localhost:1313/"
When making changes to the docs, run `make docs` again 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/phoenix/