{"id":15147935,"url":"https://github.com/pi-hole/docs","last_synced_at":"2025-05-15T14:08:00.419Z","repository":{"id":37271124,"uuid":"109050234","full_name":"pi-hole/docs","owner":"pi-hole","description":"The official Pi-hole documentation","archived":false,"fork":false,"pushed_at":"2025-05-10T10:18:32.000Z","size":11604,"stargazers_count":233,"open_issues_count":35,"forks_count":219,"subscribers_count":21,"default_branch":"master","last_synced_at":"2025-05-10T11:24:41.087Z","etag":null,"topics":["documentation","pi-hole"],"latest_commit_sha":null,"homepage":"https://docs.pi-hole.net/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc-by-sa-4.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pi-hole.png","metadata":{"funding":{"github":"pi-hole","custom":["https://pi-hole.net/donate"],"patreon":"pihole"},"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2017-10-31T20:43:06.000Z","updated_at":"2025-05-10T10:18:34.000Z","dependencies_parsed_at":"2023-02-19T15:16:26.346Z","dependency_job_id":"4486a3bc-2b7a-4d5b-873e-c9eed3132d9c","html_url":"https://github.com/pi-hole/docs","commit_stats":{"total_commits":1132,"total_committers":138,"mean_commits":8.202898550724637,"dds":0.8286219081272085,"last_synced_commit":"502c6406c1dbe175e6832d093a7a88cbb03e79ba"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pi-hole%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pi-hole%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pi-hole%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pi-hole%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pi-hole","download_url":"https://codeload.github.com/pi-hole/docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254355335,"owners_count":22057354,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","pi-hole"],"created_at":"2024-09-26T13:00:54.384Z","updated_at":"2025-05-15T14:07:55.408Z","avatar_url":"https://github.com/pi-hole.png","language":"HTML","funding_links":["https://github.com/sponsors/pi-hole","https://pi-hole.net/donate","https://patreon.com/pihole"],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://pi-hole.net/\"\u003e\n        \u003cimg src=\"https://pi-hole.github.io/graphics/Vortex/Vortex_with_Wordmark.svg\" width=\"150\" height=\"260\" alt=\"Pi-hole\"\u003e\n    \u003c/a\u003e\n    \u003cbr\u003e\n    \u003cstrong\u003eNetwork-wide ad blocking via your own Linux hardware\u003c/strong\u003e\n\u003c/p\u003e\n\nThe 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.\n\n## Documentation \u0026 User Guides\n\nThis repo is the source for the official [Pi-hole documentation](https://docs.pi-hole.net/).\n\n### How to contribute\n\nTo 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)\n\nTo add a new document or guide.\n\n- Navigate to the directory where it will be hosted.\n    E.g. guides are in `docs/guides`\n- Create the file using a URL friendly filename.\n    E.g. `docs/guides/url-friendly.md`\n- Edit your document using Markdown, there are loads of resources available for the correct syntax.\n\n### Testing your changes\n\nWhen working on this repo, it is advised that you review your changes locally before committing them. The `mkdocs serve` command can be used to live preview your changes (as you type) on your local machine.\n\nPlease make sure you fork the repo and change the clone URL in the example below for your fork:\n\n- Linux Mint / Ubuntu 20.04 LTS / 23.10 and later:\n    - Preparations (only required once):\n\n    ```bash\n    git clone https://github.com/YOUR-USERNAME/docs\n    cd docs\n    sudo apt install python3-pip python3-venv\n    python3 -m venv .venv\n    source .venv/bin/activate\n    pip3 install -r requirements.txt\n    ```\n\n    - Enter the virtual environment (if exited):\n\n    ```bash\n    source .venv/bin/activate\n    ```\n\n    - Running the docs server:\n\n    ```bash\n    mkdocs serve --dev-addr 0.0.0.0:8000\n    ```\n\n- Fedora Linux instructions (tested on Fedora Linux 28):\n    - Preparations (only required once):\n\n    ```bash\n    git clone https://github.com/YOUR-USERNAME/docs\n    cd docs\n    pip install --user -r requirements.txt\n    ```\n\n    - Running the docs server:\n\n    ```bash\n    mkdocs serve --dev-addr 0.0.0.0:8000\n    ```\n\n- Docker instructions:\n    - One-shot run:\n\n    ```bash\n    docker run -v `pwd`:/opt/app/ -w /opt/app/ -p 8000:8000 -it nikolaik/python-nodejs:python3.7-nodejs16 \\\n      sh -c \"pip install --user -r requirements.txt \u0026\u0026 \\\n      /root/.local/bin/mkdocs build \u0026\u0026 \\\n      npm ci \u0026\u0026 \\\n      npm test \u0026\u0026 \\\n      /root/.local/bin/mkdocs serve --dev-addr 0.0.0.0:8000\"\n    ```\n\nAfter these commands, the current branch is accessible through your favorite browser at \u003chttp://localhost:8000\u003e\n\n[![Deploys by Netlify](https://www.netlify.com/img/global/badges/netlify-color-bg.svg)](https://www.netlify.com/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpi-hole%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpi-hole%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpi-hole%2Fdocs/lists"}