2-adm-website #4
1 changed files with 8 additions and 2 deletions
10
README.md
10
README.md
|
|
@ -5,14 +5,20 @@ To contribute to the website, you can edit the markdown files in the `content` d
|
||||||
Firstly, you need to install [Hugo](https://gohugo.io/getting-started/installing/).
|
Firstly, you need to install [Hugo](https://gohugo.io/getting-started/installing/).
|
||||||
Next, once you have cloned the repo, you need to:
|
Next, once you have cloned the repo, you need to:
|
||||||
|
|
||||||
## 1. Format the Wiki
|
## 1. Install submodules
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git submodule init && git submodule update
|
||||||
|
```
|
||||||
|
|
||||||
|
## 2. Format the Wiki
|
||||||
Use this command to compile the wiki into hugo format:
|
Use this command to compile the wiki into hugo format:
|
||||||
> Note: Do not push any changes on the adm-wiki submodule
|
> Note: Do not push any changes on the adm-wiki submodule
|
||||||
```bash
|
```bash
|
||||||
python3 format_wiki.py
|
python3 format_wiki.py
|
||||||
```
|
```
|
||||||
|
|
||||||
## 2. Compile the Website
|
## 3. Compile the Website
|
||||||
```bash
|
```bash
|
||||||
hugo
|
hugo
|
||||||
```
|
```
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue