Skip to content

Commit 3a7e6e4

Browse files
committed
add travis file to auto generated documentation
1 parent f3598c3 commit 3a7e6e4

2 files changed

Lines changed: 30 additions & 7 deletions

File tree

.travis.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
language: go
2+
install:
3+
- export HUGO_VERSION=0.20
4+
- export HUGO_PACKAGE=hugo_${HUGO_VERSION}_Linux-64bit
5+
- curl -L https://github.com/spf13/hugo/releases/download/v$HUGO_VERSION/$HUGO_PACKAGE.tar.gz | tar xz
6+
- mkdir $HOME/bin
7+
- mv ./hugo_${HUGO_VERSION}_linux_amd64/hugo_${HUGO_VERSION}_linux_amd64 $HOME/bin/hugo
8+
script:
9+
- rm -rf docs
10+
- cd DOCUMENTATION/_settings
11+
- hugo
12+
13+
deploy:
14+
provider: pages
15+
skip_cleanup: true
16+
local_dir: public
17+
github_token: $GITHUB_TOKEN
18+
on:
19+
branch: master
20+
21+
notifications:
22+
email: false

DOCUMENTATION/_settings/content/contributing/index.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -38,17 +38,18 @@ You can request a new feature by submitting an [Issue](https://github.com/larado
3838

3939
Laradock uses [Hugo](https://gohugo.io/) as website generator tool, with the [Material Docs theme](http://themes.gohugo.io/theme/material-docs/). You might need to check their docs quickly.
4040

41+
Go the `DOCUMENTATION/_settings/content` and search for the markdown file you want to edit (every folder represents a section in the menu).
4142

42-
1. Install [Hugo](https://gohugo.io/) on your machine (easy thing).
43-
2. Open the `DOCUMENTATION/_settings/content` and search for the markdown file you want to edit (every folder represents a section in the menu).
44-
3. Delete the `/docs` folder from the root.
45-
4. When you finish editing, go to `DOCUMENTATION/_settings/` and run the `hugo` command to generate the HTML docs (inside new `/docs` folder).
43+
To edit the sidebar or add a new section, you need to edit this file `DOCUMENTATION/_settings/config.toml` as well.
44+
45+
*The site will be autogenerated in the `docs/` folder by [Travis](https://travis-ci.com/).*
4646

4747
### To Host the website locally
48-
Go to `DOCUMENTATION/_settings` in your terminal and run `hugo serve` to host the website locally.
4948

50-
### Edit the sidebar
51-
To add a new section to the sidebar or edit existing one, you need to edit this file `DOCUMENTATION/_settings/config.toml`.
49+
1. Install [Hugo](https://gohugo.io/) on your machine (easy thing).
50+
2. Edit the `DOCUMENTATION/_settings/content`.
51+
3. Delete the `/docs` folder from the root.
52+
4. When you finish editing, go to `DOCUMENTATION/_settings/` and run the `hugo` command to generate the HTML docs (inside new `/docs` folder).
5253

5354

5455

0 commit comments

Comments
 (0)