From 5f50c95af71bdaf48ca84d6f591fad545c7e598e Mon Sep 17 00:00:00 2001 From: Tom Daykin Date: Mon, 15 Oct 2018 11:47:11 +0000 Subject: [PATCH] Fixed spacing problems Signed-off-by: Tom Daykin --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 3cf032d..d31023f 100644 --- a/README.md +++ b/README.md @@ -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: