run remark linter locally

This commit is contained in:
A.Unger
2020-09-23 11:34:32 +02:00
parent d9e8b60f49
commit 97c348f1ae
447 changed files with 6178 additions and 6088 deletions
+11 -10
View File
@@ -1,13 +1,14 @@
---
* * *
title: "Building the documentation"
date: 2020-07-27T08:39:38+00:00
weight: 99
geekdocRepo: https://github.com/owncloud/ocis
geekdocRepo: <https://github.com/owncloud/ocis>
geekdocEditPath: edit/master/docs
geekdocFilePath: building-docs.md
---
{{< toc >}}
## geekdocFilePath: building-docs.md
{{&lt; toc >}}
## Buildling the documentation
@@ -15,22 +16,22 @@ Following steps can be applied for every oCIS extension repository.
### Setting up
- Install [hugo](https://gohugo.io/getting-started/installing/)
- Run `make docs`
- 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/"
Then open "http&#x3A;//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/
The documentation is automatically deployed from the master branch to <https://owncloud.github.io/phoenix/>