Pi-Hole/docs
1
0
Fork 0
mirror of https://github.com/pi-hole/docs.git synced 2025-12-20 03:08:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add deployment instructions to readme

Browse Source 
Signed-off-by: DL6ER <dl6er@dl6er.de>
This commit is contained in:
DL6ER
2018-05-01 14:17:37 +02:00
parent 2db390f9a1
commit 867d5cc57c
1 changed files with 7 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@@ -9,3 +9,10 @@ sudo pip install mkdocs
sudo pip install mkdocs-material
mkdocs serve
```
Deploying to GitHub pages:
```
mkdocs gh-deploy
```
MkDocs will build the docs and use the `ghp-import` tool to commit them to our `gh-pages` branch and also automatically push the `gh-pages` branch to GitHub.
Warning: Be aware that you will not be able to review the built site before it is pushed to GitHub! Therefore, you **must** verify any changes you make to the docs beforehand by using the `mkdocs serve` command and reviewing the built files locally.