mirror of
https://github.com/pi-hole/docs.git
synced 2024-12-06 19:27:12 +01:00
DL6ER
19 lines
721 B
Markdown
19 lines
721 B
Markdown
If you want to work on this repo, you can preview the site as you work.
|
|
|
|
Linux Mint / Ubuntu instructions:
|
|
|
|
```
|
|
git clone git@github.com:pi-hole/docs.git
|
|
cd docs
|
|
sudo pip install mkdocs
|
|
sudo pip install mkdocs-material
|
|
mkdocs serve --dev-addr 0.0.0.0:8000
|
|
```
|
|
|
|
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.
|