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 2 Packages Projects Releases Wiki Activity

Fixed spacing problems

Browse Source 
Signed-off-by: Tom Daykin <tdaykin@live.co.uk>
This commit is contained in:
Tom Daykin
2018-10-15 11:47:11 +00:00
parent 6774634c3c
commit 5f50c95af7
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+7 -7
View File
@@ -1,21 +1,21 @@
## Documentation & User Guides
## Documentation & User Guides
This repo is the source for the official [Pi-hole documentation](https://docs.pi-hole.net/).
#### How to contribute.
### How to contribute.
To add a new link on the navigation panel you need to edit the `mkdocs.yml` file in the root of the repo. There is a guide for building the navbar [on the mkdocs wiki]( https://www.mkdocs.org/user-guide/configuration/#nav)
To add a new document or guide.
To add a new document or guide.
- Navigate to the directory where it will be hosted.
- Navigate to the directory where it will be hosted.
EG. guides are in `docs/guides`
- Create the file using a URL friendly filename.
- Create the file using a URL friendly filename.
EG. `docs/guides/url-friendly.md`
- Edit your document using Markdown, there are loads of resources available for the correct syntax.
#### Testing your changes.
Whilst working on this repo, it is advised that you review your own changes locally before commiting them. This can be done by using the `mkdocs serve` command.
### Testing your changes.
Whilst working on this repo, it is advised that you review your own changes locally before commiting them. This can be done by using the `mkdocs serve` command.
Please make sure you fork the repo and change the clone URL in the example below for your fork: