From 65baac45d0e676e41e6f1410563e66eff79ba0da Mon Sep 17 00:00:00 2001 From: Lukas Hirt Date: Mon, 27 Jul 2020 10:43:34 +0200 Subject: [PATCH] Add docs how to work with hugo --- docs/building-docs.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 docs/building-docs.md diff --git a/docs/building-docs.md b/docs/building-docs.md new file mode 100644 index 000000000..5167657b1 --- /dev/null +++ b/docs/building-docs.md @@ -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/ +