blackbirdchess/blackbirdchess-docker-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update contrubition docs

Browse Source
This commit is contained in:
Mahmoud Zalt 2017-04-14 14:37:31 -04:00
parent 07ad461e75
commit 43ace2bebe
1 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -38,18 +38,23 @@ 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).
Go the `DOCUMENTATION/_settings/content` and search for the markdown file you want to edit
To edit the sidebar or add a new section, you need to edit this file `DOCUMENTATION/_settings/config.toml` as well.
Note: Every folder represents a section in the sidebar "Menu". And every page and sidebar has a `weight` number to show it's position in the site.
*The site will be autogenerated in the `docs/` folder by [Travis](https://travis-ci.com/).*
To update the sidebar or add a new section to it, you can edit this `DOCUMENTATION/_settings/config.toml` toml file.
> The site will be auto-generated in the `docs/` folder by [Travis CI](https://travis-ci.org/laradock/laradock/).
<br>
### To Host the website locally
1. Install [Hugo](https://gohugo.io/) on your machine (easy thing).
1. Install [Hugo](https://gohugo.io/) on your machine.
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).
4. After you finish the editing, go to `DOCUMENTATION/_settings/` and run the `hugo` command to generate the HTML docs (inside a new `/docs` folder).