Skip to content
Snippets Groups Projects
Verified Commit 5cc03119 authored by Šimon Berka's avatar Šimon Berka
Browse files

update Contribute page with Hugo information

parent bf488e91
No related branches found
No related tags found
No related merge requests found
......@@ -4,33 +4,12 @@ date: 2021-05-18T11:22:35+02:00
draft: false
---
{{< hint danger >}}
**WARNING:**
This page requires an update.
{{< /hint >}}
We use open-source [Hugo](https://gohugo.io/) project to generate the documentation.
## Requirements
Working with our documentation requires the following tools:
* *git* for version control
* *nodejs* and *gitbook* for content management
[Install](https://gohugo.io/getting-started/installing/) Hugo
This documentation is written in the *Markdown* markup language.
```bash
# Debian
apt-get install nodejs git
```
```bash
# CentOS
yum install nodejs git
```
```bash
# Fedora
dnf install nodejs git
```
Or see [NodeJS Documentation](https://nodejs.org/en/download/package-manager/) for distro-specific instructions.
## Work-flow Overview
1. Fork & clone repository
......@@ -54,19 +33,10 @@ git clone git@gitlab.ics.muni.cz:${GITLAB_USER}/documentation.git
git checkout -b my_change
```
## Install GitBook
```bash
npm install gitbook-cli -g
# in `documentation`
gitbook install
```
This step MAY require `sudo` depending on your system and NodeJS installation method.
## Edit GitBook
```bash
# in `documentation`
gitbook serve
hugo --config config-dev.toml serve
```
> Edits will be show live in your browser window, no need to refresh.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment