pi-hole/docs
1
0
Fork 0
mirror of https://github.com/pi-hole/docs.git synced 2024-12-06 19:27:12 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Update README

Browse Source 
Signed-off-by: DL6ER <dl6er@dl6er.de>
This commit is contained in:
DL6ER
2018-10-13 10:41:59 +02:00
parent 6213f3e7fe
commit 6648792cdf
1 changed files with 35 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+35 -15
View File
@@ -1,18 +1,38 @@
If you want to work on this repo, you can preview the site as you work.
<p align="center">
<a href="https://pi-hole.net"><img src="https://pi-hole.github.io/graphics/Vortex/Vortex_with_text.png" width="150" height="255" alt="Pi-hole"></a>
<br/><br/>
<b>Network-wide ad blocking via your own Linux hardware</b><br/>
</p>
Linux Mint / Ubuntu instructions:
The Pi-hole[®](https://pi-hole.net/trademark-rules-and-brand-guidelines/) is a [DNS sinkhole](https://en.wikipedia.org/wiki/DNS_Sinkhole) that protects your devices from unwanted content, without installing any client-side software.
```
git clone git@github.com:pi-hole/docs.git
cd docs
sudo pip install mkdocs
sudo pip install mkdocs-material markdown-include
mkdocs serve --dev-addr 0.0.0.0:8000
```
This repository provides the official Pi-hole documentation you can find here: https://docs.pi-hole.net
If you want to work on the documentation, you can live preview your changes (as you type) on your local machine. We compiled instructions tested on Linux Mint 18 and Fedora 28:
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.
- Linux Mint / Ubuntu instructions:
- Preparations (only required once):
```
git clone git@github.com:pi-hole/docs.git
cd docs
sudo pip install mkdocs
sudo pip install mkdocs-material markdown-include
```
- Running the docs server:
```
mkdocs serve --dev-addr 0.0.0.0:8000
```
- Fedora Linux instructions:
- Preparations (only required once):
```
git clone git@github.com:pi-hole/docs.git
cd docs
pip install mkdocs --user
pip install mkdocs-material markdown-include --user
```
- Running the docs server:
```
mkdocs serve --dev-addr 0.0.0.0:8000
```
After these commands, the currently checked out branch is accessible through your favorite browser at http://localhost:8000