mirror of
https://github.com/pi-hole/docs.git
synced 2025-12-20 11:18:37 +00:00
Change theme, make a start on index page. Add .gitignore
Signed-off-by: Adam Warner <adamw@rner.email>
This commit is contained in:
2
.gitignore
vendored
Normal file
2
.gitignore
vendored
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
*.iml
|
||||||
|
/.idea
|
||||||
1
.idea/misc.xml
generated
1
.idea/misc.xml
generated
@@ -3,4 +3,5 @@
|
|||||||
<component name="ProjectRootManager">
|
<component name="ProjectRootManager">
|
||||||
<output url="file://$PROJECT_DIR$/out" />
|
<output url="file://$PROJECT_DIR$/out" />
|
||||||
</component>
|
</component>
|
||||||
|
<component name="WebServicesPlugin" addRequiredLibraries="true" />
|
||||||
</project>
|
</project>
|
||||||
83
.idea/workspace.xml
generated
83
.idea/workspace.xml
generated
@@ -1,7 +1,12 @@
|
|||||||
<?xml version="1.0" encoding="UTF-8"?>
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
<project version="4">
|
<project version="4">
|
||||||
<component name="ChangeListManager">
|
<component name="ChangeListManager">
|
||||||
<list default="true" id="b7c3ae2f-013e-4209-98b9-1ec1ce4d51d8" name="Default" comment="" />
|
<list default="true" id="b7c3ae2f-013e-4209-98b9-1ec1ce4d51d8" name="Default" comment="Change theme, make a start on index page. Add .gitignore">
|
||||||
|
<change beforePath="$PROJECT_DIR$/.gitignore" afterPath="$PROJECT_DIR$/.gitignore" />
|
||||||
|
<change beforePath="$PROJECT_DIR$/.idea/misc.xml" afterPath="" />
|
||||||
|
<change beforePath="$PROJECT_DIR$/.idea/modules.xml" afterPath="" />
|
||||||
|
<change beforePath="$PROJECT_DIR$/.idea/workspace.xml" afterPath="" />
|
||||||
|
</list>
|
||||||
<ignored path="$PROJECT_DIR$/out/" />
|
<ignored path="$PROJECT_DIR$/out/" />
|
||||||
<option name="EXCLUDED_CONVERTED_TO_IGNORED" value="true" />
|
<option name="EXCLUDED_CONVERTED_TO_IGNORED" value="true" />
|
||||||
<option name="TRACKING_ENABLED" value="true" />
|
<option name="TRACKING_ENABLED" value="true" />
|
||||||
@@ -10,11 +15,26 @@
|
|||||||
<option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
|
<option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
|
||||||
<option name="LAST_RESOLUTION" value="IGNORE" />
|
<option name="LAST_RESOLUTION" value="IGNORE" />
|
||||||
</component>
|
</component>
|
||||||
|
<component name="FileEditorManager">
|
||||||
|
<leaf />
|
||||||
|
</component>
|
||||||
|
<component name="Git.Settings">
|
||||||
|
<option name="RECENT_GIT_ROOT_PATH" value="$PROJECT_DIR$" />
|
||||||
|
</component>
|
||||||
<component name="GradleLocalSettings">
|
<component name="GradleLocalSettings">
|
||||||
<option name="externalProjectsViewState">
|
<option name="externalProjectsViewState">
|
||||||
<projects_view />
|
<projects_view />
|
||||||
</option>
|
</option>
|
||||||
</component>
|
</component>
|
||||||
|
<component name="IdeDocumentHistory">
|
||||||
|
<option name="CHANGED_PATHS">
|
||||||
|
<list>
|
||||||
|
<option value="$PROJECT_DIR$/mkdocs.yml" />
|
||||||
|
<option value="$PROJECT_DIR$/docs/index.md" />
|
||||||
|
<option value="$PROJECT_DIR$/.gitignore" />
|
||||||
|
</list>
|
||||||
|
</option>
|
||||||
|
</component>
|
||||||
<component name="JsBuildToolGruntFileManager" detection-done="true" sorting="DEFINITION_ORDER" />
|
<component name="JsBuildToolGruntFileManager" detection-done="true" sorting="DEFINITION_ORDER" />
|
||||||
<component name="JsBuildToolPackageJson" detection-done="true" sorting="DEFINITION_ORDER" />
|
<component name="JsBuildToolPackageJson" detection-done="true" sorting="DEFINITION_ORDER" />
|
||||||
<component name="JsGulpfileManager">
|
<component name="JsGulpfileManager">
|
||||||
@@ -28,6 +48,9 @@
|
|||||||
<option name="width" value="974" />
|
<option name="width" value="974" />
|
||||||
<option name="height" value="1047" />
|
<option name="height" value="1047" />
|
||||||
</component>
|
</component>
|
||||||
|
<component name="ProjectLevelVcsManager" settingsEditedManually="true">
|
||||||
|
<ConfirmationsSetting value="2" id="Add" />
|
||||||
|
</component>
|
||||||
<component name="ProjectView">
|
<component name="ProjectView">
|
||||||
<navigator currentView="ProjectPane" proportions="" version="1">
|
<navigator currentView="ProjectPane" proportions="" version="1">
|
||||||
<flattenPackages />
|
<flattenPackages />
|
||||||
@@ -174,12 +197,20 @@
|
|||||||
<option name="number" value="Default" />
|
<option name="number" value="Default" />
|
||||||
<option name="presentableId" value="Default" />
|
<option name="presentableId" value="Default" />
|
||||||
<updated>1509482551316</updated>
|
<updated>1509482551316</updated>
|
||||||
<workItem from="1509482553044" duration="61000" />
|
<workItem from="1509482553044" duration="2272000" />
|
||||||
</task>
|
</task>
|
||||||
|
<task id="LOCAL-00001" summary="Change theme, make a start on index page. Add .gitignore">
|
||||||
|
<created>1509489920707</created>
|
||||||
|
<option name="number" value="00001" />
|
||||||
|
<option name="presentableId" value="LOCAL-00001" />
|
||||||
|
<option name="project" value="LOCAL" />
|
||||||
|
<updated>1509489920707</updated>
|
||||||
|
</task>
|
||||||
|
<option name="localTasksCounter" value="2" />
|
||||||
<servers />
|
<servers />
|
||||||
</component>
|
</component>
|
||||||
<component name="TimeTrackingManager">
|
<component name="TimeTrackingManager">
|
||||||
<option name="totallyTimeSpent" value="61000" />
|
<option name="totallyTimeSpent" value="2272000" />
|
||||||
</component>
|
</component>
|
||||||
<component name="ToolWindowManager">
|
<component name="ToolWindowManager">
|
||||||
<frame x="1912" y="-8" width="1936" height="1056" extended-state="6" />
|
<frame x="1912" y="-8" width="1936" height="1056" extended-state="6" />
|
||||||
@@ -191,7 +222,7 @@
|
|||||||
<window_info id="Capture Analysis" active="false" anchor="right" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" show_stripe_button="true" weight="0.33" sideWeight="0.5" order="-1" side_tool="false" content_ui="tabs" />
|
<window_info id="Capture Analysis" active="false" anchor="right" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" show_stripe_button="true" weight="0.33" sideWeight="0.5" order="-1" side_tool="false" content_ui="tabs" />
|
||||||
<window_info id="Event Log" active="false" anchor="bottom" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" show_stripe_button="true" weight="0.33" sideWeight="0.5" order="-1" side_tool="true" content_ui="tabs" />
|
<window_info id="Event Log" active="false" anchor="bottom" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" show_stripe_button="true" weight="0.33" sideWeight="0.5" order="-1" side_tool="true" content_ui="tabs" />
|
||||||
<window_info id="Maven Projects" active="false" anchor="right" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" show_stripe_button="true" weight="0.33" sideWeight="0.5" order="-1" side_tool="false" content_ui="tabs" />
|
<window_info id="Maven Projects" active="false" anchor="right" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" show_stripe_button="true" weight="0.33" sideWeight="0.5" order="-1" side_tool="false" content_ui="tabs" />
|
||||||
<window_info id="Version Control" active="false" anchor="bottom" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" show_stripe_button="false" weight="0.33" sideWeight="0.5" order="-1" side_tool="false" content_ui="tabs" />
|
<window_info id="Version Control" active="false" anchor="bottom" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" show_stripe_button="true" weight="0.33" sideWeight="0.5" order="-1" side_tool="false" content_ui="tabs" />
|
||||||
<window_info id="Run" active="false" anchor="bottom" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" show_stripe_button="true" weight="0.33" sideWeight="0.5" order="2" side_tool="false" content_ui="tabs" />
|
<window_info id="Run" active="false" anchor="bottom" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" show_stripe_button="true" weight="0.33" sideWeight="0.5" order="2" side_tool="false" content_ui="tabs" />
|
||||||
<window_info id="Terminal" active="false" anchor="bottom" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" show_stripe_button="true" weight="0.33" sideWeight="0.5" order="-1" side_tool="false" content_ui="tabs" />
|
<window_info id="Terminal" active="false" anchor="bottom" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" show_stripe_button="true" weight="0.33" sideWeight="0.5" order="-1" side_tool="false" content_ui="tabs" />
|
||||||
<window_info id="Capture Tool" active="false" anchor="left" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" show_stripe_button="true" weight="0.33" sideWeight="0.5" order="-1" side_tool="false" content_ui="tabs" />
|
<window_info id="Capture Tool" active="false" anchor="left" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" show_stripe_button="true" weight="0.33" sideWeight="0.5" order="-1" side_tool="false" content_ui="tabs" />
|
||||||
@@ -219,10 +250,54 @@
|
|||||||
<component name="VcsContentAnnotationSettings">
|
<component name="VcsContentAnnotationSettings">
|
||||||
<option name="myLimit" value="2678400000" />
|
<option name="myLimit" value="2678400000" />
|
||||||
</component>
|
</component>
|
||||||
|
<component name="VcsManagerConfiguration">
|
||||||
|
<MESSAGE value="Change theme, make a start on index page. Add .gitignore" />
|
||||||
|
<option name="LAST_COMMIT_MESSAGE" value="Change theme, make a start on index page. Add .gitignore" />
|
||||||
|
</component>
|
||||||
<component name="XDebuggerManager">
|
<component name="XDebuggerManager">
|
||||||
<breakpoint-manager />
|
<breakpoint-manager />
|
||||||
<watches-manager />
|
<watches-manager />
|
||||||
</component>
|
</component>
|
||||||
|
<component name="editorHistoryManager">
|
||||||
|
<entry file="file://$PROJECT_DIR$/.gitignore">
|
||||||
|
<provider selected="true" editor-type-id="text-editor">
|
||||||
|
<state relative-caret-position="17">
|
||||||
|
<caret line="1" column="0" lean-forward="false" selection-start-line="1" selection-start-column="0" selection-end-line="1" selection-end-column="0" />
|
||||||
|
<folding />
|
||||||
|
</state>
|
||||||
|
</provider>
|
||||||
|
</entry>
|
||||||
|
<entry file="file://$PROJECT_DIR$/mkdocs.yml">
|
||||||
|
<provider selected="true" editor-type-id="text-editor">
|
||||||
|
<state relative-caret-position="289">
|
||||||
|
<caret line="17" column="0" lean-forward="true" selection-start-line="17" selection-start-column="0" selection-end-line="17" selection-end-column="0" />
|
||||||
|
<folding />
|
||||||
|
</state>
|
||||||
|
</provider>
|
||||||
|
</entry>
|
||||||
|
<entry file="file://$PROJECT_DIR$/docs/index.md">
|
||||||
|
<provider selected="true" editor-type-id="split-provider[text-editor;markdown-preview-editor]">
|
||||||
|
<state split_layout="SPLIT">
|
||||||
|
<first_editor relative-caret-position="255">
|
||||||
|
<caret line="15" column="21" lean-forward="false" selection-start-line="15" selection-start-column="21" selection-end-line="15" selection-end-column="21" />
|
||||||
|
<folding />
|
||||||
|
</first_editor>
|
||||||
|
<second_editor />
|
||||||
|
</state>
|
||||||
|
</provider>
|
||||||
|
</entry>
|
||||||
|
<entry file="file://$PROJECT_DIR$/docs/prerequesites.md">
|
||||||
|
<provider selected="true" editor-type-id="split-provider[text-editor;markdown-preview-editor]">
|
||||||
|
<state split_layout="SPLIT">
|
||||||
|
<first_editor relative-caret-position="0">
|
||||||
|
<caret line="0" column="0" lean-forward="false" selection-start-line="0" selection-start-column="0" selection-end-line="0" selection-end-column="0" />
|
||||||
|
<folding />
|
||||||
|
</first_editor>
|
||||||
|
<second_editor />
|
||||||
|
</state>
|
||||||
|
</provider>
|
||||||
|
</entry>
|
||||||
|
</component>
|
||||||
<component name="masterDetails">
|
<component name="masterDetails">
|
||||||
<states>
|
<states>
|
||||||
<state key="ProjectJDKs.UI">
|
<state key="ProjectJDKs.UI">
|
||||||
|
|||||||
@@ -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.
|
### Forums
|
||||||
* `mkdocs serve` - Start the live-reloading docs server.
|
- [Pi-hole Discourse](https://discourse.pi-hole.net)
|
||||||
* `mkdocs build` - Build the documentation site.
|
- Reddit : [/r/pihole](https://reddit.com/r/pihole)
|
||||||
* `mkdocs help` - Print this help message.
|
|
||||||
|
|
||||||
## Project layout
|
### Social Media
|
||||||
|
- Twitter : [@the_pi_hole](https://twitter.com/the_pi_hole)
|
||||||
mkdocs.yml # The configuration file.
|
- Facebook : [ThePiHole](https://facebook.com/ThePiHole)
|
||||||
docs/
|
|
||||||
index.md # The documentation homepage.
|
|
||||||
... # Other markdown pages, images and other files.
|
|
||||||
0
docs/prerequesites.md
Normal file
0
docs/prerequesites.md
Normal file
18
mkdocs.yml
18
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
|
||||||
|
|||||||
Reference in New Issue
Block a user