diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..3edbdf0 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +*.iml +/.idea diff --git a/.idea/misc.xml b/.idea/misc.xml index 639900d..6991c89 100644 --- a/.idea/misc.xml +++ b/.idea/misc.xml @@ -3,4 +3,5 @@ + \ No newline at end of file diff --git a/.idea/workspace.xml b/.idea/workspace.xml index 196677a..6d7bcf7 100644 --- a/.idea/workspace.xml +++ b/.idea/workspace.xml @@ -1,7 +1,12 @@ - + + + + + + + + + + + + + + @@ -28,6 +48,9 @@ + + + @@ -174,12 +197,20 @@ - @@ -191,7 +222,7 @@ - + @@ -219,10 +250,54 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/index.md b/docs/index.md index da37213..37b31e1 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,17 +1,16 @@ -# Welcome to MkDocs +# Welcome to Pi-hole Documentation -For full documentation visit [mkdocs.org](http://mkdocs.org). +## Get Support -## Commands +### Github +- Pi-hole core : [pi-hole/pi-hole](https://github.com/pi-hole/pi-hole) +- Pi-hole web : [pi-hole/adminLTE](https://github.com/pi-hole/adminLTE) +- Pi-hole FTL : [pi-hole/FTL](https://github.com/pi-hole/FTL) -* `mkdocs new [dir-name]` - Create a new project. -* `mkdocs serve` - Start the live-reloading docs server. -* `mkdocs build` - Build the documentation site. -* `mkdocs help` - Print this help message. +### Forums +- [Pi-hole Discourse](https://discourse.pi-hole.net) +- Reddit : [/r/pihole](https://reddit.com/r/pihole) -## Project layout - - mkdocs.yml # The configuration file. - docs/ - index.md # The documentation homepage. - ... # Other markdown pages, images and other files. +### Social Media +- Twitter : [@the_pi_hole](https://twitter.com/the_pi_hole) +- Facebook : [ThePiHole](https://facebook.com/ThePiHole) \ No newline at end of file diff --git a/docs/prerequesites.md b/docs/prerequesites.md new file mode 100644 index 0000000..e69de29 diff --git a/mkdocs.yml b/mkdocs.yml index c97182f..3376884 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1 +1,17 @@ -site_name: My Docs +site_name: "Pi-hole documentation" +site_url: https://pi-hole.github.io/docs/ +copyright: 'Copyright © 2017 Pi-hole LLC' +repo_name: pi-hole/docs +repo_url: https://github.com/pi-hole/docs +edit_uri: ../docs/edit/master/docs/ +remote_branch: gh-pages +theme: material +pages: +- 'Information & Support': 'index.md' +- 'Prerequisites': 'prerequesites.md' +extra: + social: + - type: globe + link: https://pi-hole.net + - type: github-alt + link: https://github.com/pi-hole