From 5c4a05a2adedd2c11a49b8a8e5a06d5039891217 Mon Sep 17 00:00:00 2001 From: RD WebDesign Date: Wed, 19 Mar 2025 00:36:55 -0300 Subject: [PATCH] Use external file to show always up-to-date `pihole.toml` content Signed-off-by: RD WebDesign --- docs/ftldns/configfile.md | 6 ++++++ mkdocs.yml | 2 ++ 2 files changed, 8 insertions(+) diff --git a/docs/ftldns/configfile.md b/docs/ftldns/configfile.md index e13b32818..101c67af1 100644 --- a/docs/ftldns/configfile.md +++ b/docs/ftldns/configfile.md @@ -5,3 +5,9 @@ The configuration file can be found at `/etc/pihole/pihole.toml`, all of the opt The file can be edited directly, however you can also use the command line option (`pihole-FTL --config`) or the web interface. There is also an outline of the configuration options in the [api documentation](../api/index.md#accessing-the-api-documentation). + +## Pi-hole configuration file example - `pihole.toml`: + +```toml +--8<-- "https://raw.githubusercontent.com/pi-hole/FTL/refs/heads/master/test/pihole.toml" +``` diff --git a/mkdocs.yml b/mkdocs.yml index cf116f2ba..4bccd1340 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -89,6 +89,8 @@ markdown_extensions: - markdown_include.include: base_path: docs - pymdownx.snippets: + # allow include external URL content + url_download: true # auto_append abbreviations.md to every file # https://squidfunk.github.io/mkdocs-material/reference/tooltips/#adding-a-glossary auto_append: