ykxiao/laradock
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

add travis file to auto generated documentation

Browse Source
This commit is contained in:
Mahmoud Zalt
2017-04-14 03:55:08 -04:00
parent f3598c3c97
commit 3a7e6e4b1a
2 changed files with 30 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
DOCUMENTATION/_settings/content/contributing/index.md
View File

@ -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).