add travis file to auto generated documentation
This commit is contained in:
parent
f3598c3c97
commit
3a7e6e4b1a
22
.travis.yml
Normal file
22
.travis.yml
Normal file
@ -0,0 +1,22 @@
|
||||
language: go
|
||||
install:
|
||||
- export HUGO_VERSION=0.20
|
||||
- export HUGO_PACKAGE=hugo_${HUGO_VERSION}_Linux-64bit
|
||||
- curl -L https://github.com/spf13/hugo/releases/download/v$HUGO_VERSION/$HUGO_PACKAGE.tar.gz | tar xz
|
||||
- mkdir $HOME/bin
|
||||
- mv ./hugo_${HUGO_VERSION}_linux_amd64/hugo_${HUGO_VERSION}_linux_amd64 $HOME/bin/hugo
|
||||
script:
|
||||
- rm -rf docs
|
||||
- cd DOCUMENTATION/_settings
|
||||
- hugo
|
||||
|
||||
deploy:
|
||||
provider: pages
|
||||
skip_cleanup: true
|
||||
local_dir: public
|
||||
github_token: $GITHUB_TOKEN
|
||||
on:
|
||||
branch: master
|
||||
|
||||
notifications:
|
||||
email: false
|
@ -38,17 +38,18 @@ You can request a new feature by submitting an [Issue](https://github.com/larado
|
||||
|
||||
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.
|
||||
|
||||
Go the `DOCUMENTATION/_settings/content` and search for the markdown file you want to edit (every folder represents a section in the menu).
|
||||
|
||||
1. Install [Hugo](https://gohugo.io/) on your machine (easy thing).
|
||||
2. Open the `DOCUMENTATION/_settings/content` and search for the markdown file you want to edit (every folder represents a section in the menu).
|
||||
3. Delete the `/docs` folder from the root.
|
||||
4. When you finish editing, go to `DOCUMENTATION/_settings/` and run the `hugo` command to generate the HTML docs (inside new `/docs` folder).
|
||||
To edit the sidebar or add a new section, you need to edit this file `DOCUMENTATION/_settings/config.toml` as well.
|
||||
|
||||
*The site will be autogenerated in the `docs/` folder by [Travis](https://travis-ci.com/).*
|
||||
|
||||
### To Host the website locally
|
||||
Go to `DOCUMENTATION/_settings` in your terminal and run `hugo serve` to host the website locally.
|
||||
|
||||
### Edit the sidebar
|
||||
To add a new section to the sidebar or edit existing one, you need to edit this file `DOCUMENTATION/_settings/config.toml`.
|
||||
1. Install [Hugo](https://gohugo.io/) on your machine (easy thing).
|
||||
2. Edit the `DOCUMENTATION/_settings/content`.
|
||||
3. Delete the `/docs` folder from the root.
|
||||
4. When you finish editing, go to `DOCUMENTATION/_settings/` and run the `hugo` command to generate the HTML docs (inside new `/docs` folder).
|
||||
|
||||
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user