From d644b5ea97ddcd6859112abe7abee557e4627b4e Mon Sep 17 00:00:00 2001 From: yubiuser Date: Mon, 17 Nov 2025 20:07:20 +0100 Subject: [PATCH] Remove markdown-include and use snippets instead Signed-off-by: yubiuser --- docs/api/auth.md | 1 - docs/api/index.md | 1 - docs/guides/vpn/openvpn/android-client.md | 4 +++- docs/guides/vpn/openvpn/clients.md | 4 +++- docs/guides/vpn/openvpn/dual-VPN.md | 4 +++- docs/guides/vpn/openvpn/dual-operation.md | 4 +++- docs/guides/vpn/openvpn/dynDNS.md | 4 +++- docs/guides/vpn/openvpn/firewall.md | 4 +++- docs/guides/vpn/openvpn/index.md | 4 +++- docs/guides/vpn/openvpn/installation.md | 4 +++- docs/guides/vpn/openvpn/only-dns-via-vpn.md | 4 +++- docs/guides/vpn/openvpn/setup-openvpn-server.md | 4 +++- docs/guides/vpn/openvpn/troubleshooting.md | 4 +++- mkdocs.yml | 4 ---- requirements.txt | 1 - 15 files changed, 33 insertions(+), 18 deletions(-) diff --git a/docs/api/auth.md b/docs/api/auth.md index db8125c..18eb79d 100644 --- a/docs/api/auth.md +++ b/docs/api/auth.md @@ -418,4 +418,3 @@ Session-based authentication, while convenient and widely used, does have severa Remember, no security measure is foolproof, but by understanding the potential risks and the multiple layers of defense your Pi-hole implemented against these risks, you can make an informed decision about how to use the Pi-hole API securely in the context of your own scripts. Always use the secure transmission method (HTTPS) offered by your Pi-hole to access the API. The strong encryption will prevent attackers from eavesdropping on your requests and makes stealing your session ID basically impossible. -{!abbreviations.md!} diff --git a/docs/api/index.md b/docs/api/index.md index f3d2915..7b8c2b4 100644 --- a/docs/api/index.md +++ b/docs/api/index.md @@ -200,4 +200,3 @@ Code | Description | Interpretation We recommend writing code that gracefully handles all possible API exceptions. The Pi-hole API is designed to support this by standardized error messages and human-readable hints for errors. -{!abbreviations.md!} diff --git a/docs/guides/vpn/openvpn/android-client.md b/docs/guides/vpn/openvpn/android-client.md index 87699d6..128e75c 100644 --- a/docs/guides/vpn/openvpn/android-client.md +++ b/docs/guides/vpn/openvpn/android-client.md @@ -1,4 +1,6 @@ -{!guides/vpn/openvpn/deprecation_notice.md!} +--8<-- +docs/guides/vpn/openvpn/deprecation_notice.md +--8<-- - Install the official OpenVPN App from the [App Store](https://play.google.com/store/apps/details?id=net.openvpn.openvpn) diff --git a/docs/guides/vpn/openvpn/clients.md b/docs/guides/vpn/openvpn/clients.md index c3fd90f..5668698 100644 --- a/docs/guides/vpn/openvpn/clients.md +++ b/docs/guides/vpn/openvpn/clients.md @@ -1,4 +1,6 @@ -{!guides/vpn/openvpn/deprecation_notice.md!} +--8<-- +docs/guides/vpn/openvpn/deprecation_notice.md +--8<-- ## Create a client config file (`.ovpn`) diff --git a/docs/guides/vpn/openvpn/dual-VPN.md b/docs/guides/vpn/openvpn/dual-VPN.md index 1b9757c..ff4b281 100644 --- a/docs/guides/vpn/openvpn/dual-VPN.md +++ b/docs/guides/vpn/openvpn/dual-VPN.md @@ -1,4 +1,6 @@ -{!guides/vpn/openvpn/deprecation_notice.md!} +--8<-- +docs/guides/vpn/openvpn/deprecation_notice.md +--8<-- ### Dual VPN Setup - Separate DNS and VPN Traffic diff --git a/docs/guides/vpn/openvpn/dual-operation.md b/docs/guides/vpn/openvpn/dual-operation.md index 3facb29..e93af3a 100644 --- a/docs/guides/vpn/openvpn/dual-operation.md +++ b/docs/guides/vpn/openvpn/dual-operation.md @@ -1,4 +1,6 @@ -{!guides/vpn/openvpn/deprecation_notice.md!} +--8<-- +docs/guides/vpn/openvpn/deprecation_notice.md +--8<-- **Up until now, this wiki has been about a server set up on a cloud host, available on the public Internet. This section is aimed at a server set up in a private network like on a Raspberry Pi.** diff --git a/docs/guides/vpn/openvpn/dynDNS.md b/docs/guides/vpn/openvpn/dynDNS.md index ebcdb5b..b548427 100644 --- a/docs/guides/vpn/openvpn/dynDNS.md +++ b/docs/guides/vpn/openvpn/dynDNS.md @@ -1,4 +1,6 @@ -{!guides/vpn/openvpn/deprecation_notice.md!} +--8<-- +docs/guides/vpn/openvpn/deprecation_notice.md +--8<-- If you operate your Pi-hole + OpenVPN at home, you are likely sitting behind a NAT / dynamically changing IP address. In this case, you should set up a dynamic DNS record, which allows you to reach your server. You can exchange the address that has been configured during the setup of OpenVPN like this: diff --git a/docs/guides/vpn/openvpn/firewall.md b/docs/guides/vpn/openvpn/firewall.md index cb24905..e4bc466 100644 --- a/docs/guides/vpn/openvpn/firewall.md +++ b/docs/guides/vpn/openvpn/firewall.md @@ -1,4 +1,6 @@ -{!guides/vpn/openvpn/deprecation_notice.md!} +--8<-- +docs/guides/vpn/openvpn/deprecation_notice.md +--8<-- ### (optional) Secure the server with firewall rules (`iptables`) diff --git a/docs/guides/vpn/openvpn/index.md b/docs/guides/vpn/openvpn/index.md index 64eba7f..8671c2d 100644 --- a/docs/guides/vpn/openvpn/index.md +++ b/docs/guides/vpn/openvpn/index.md @@ -1,4 +1,6 @@ -{!guides/vpn/openvpn/deprecation_notice.md!} +--8<-- +docs/guides/vpn/openvpn/deprecation_notice.md +--8<-- This tutorial is tailored for setting up OpenVPN on a cloud-hosted virtual server. If you wish to have this working on your home network, you will need to tailor Pi-hole to listen on `eth0` (or similar), which we explain in [this section of the tutorial](dual-operation.md). diff --git a/docs/guides/vpn/openvpn/installation.md b/docs/guides/vpn/openvpn/installation.md index dc85e0c..d27c5ac 100644 --- a/docs/guides/vpn/openvpn/installation.md +++ b/docs/guides/vpn/openvpn/installation.md @@ -1,4 +1,6 @@ -{!guides/vpn/openvpn/deprecation_notice.md!} +--8<-- +docs/guides/vpn/openvpn/deprecation_notice.md +--8<-- ## Install an operating system diff --git a/docs/guides/vpn/openvpn/only-dns-via-vpn.md b/docs/guides/vpn/openvpn/only-dns-via-vpn.md index f7c64b6..3873a10 100644 --- a/docs/guides/vpn/openvpn/only-dns-via-vpn.md +++ b/docs/guides/vpn/openvpn/only-dns-via-vpn.md @@ -1,4 +1,6 @@ -{!guides/vpn/openvpn/deprecation_notice.md!} +--8<-- +docs/guides/vpn/openvpn/deprecation_notice.md +--8<-- ### Optional: Only route DNS via VPN diff --git a/docs/guides/vpn/openvpn/setup-openvpn-server.md b/docs/guides/vpn/openvpn/setup-openvpn-server.md index 15876f6..bf9df97 100644 --- a/docs/guides/vpn/openvpn/setup-openvpn-server.md +++ b/docs/guides/vpn/openvpn/setup-openvpn-server.md @@ -1,4 +1,6 @@ -{!guides/vpn/openvpn/deprecation_notice.md!} +--8<-- +docs/guides/vpn/openvpn/deprecation_notice.md +--8<-- ### Change OpenVPN's resolvers diff --git a/docs/guides/vpn/openvpn/troubleshooting.md b/docs/guides/vpn/openvpn/troubleshooting.md index 40deeec..580d84c 100644 --- a/docs/guides/vpn/openvpn/troubleshooting.md +++ b/docs/guides/vpn/openvpn/troubleshooting.md @@ -1,4 +1,6 @@ -{!guides/vpn/openvpn/deprecation_notice.md!} +--8<-- +docs/guides/vpn/openvpn/deprecation_notice.md +--8<-- ### CRL expired diff --git a/mkdocs.yml b/mkdocs.yml index 8676d19..bfb8a2a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -85,15 +85,11 @@ markdown_extensions: # Adds the ability to define abbreviations (https://squidfunk.github.io/mkdocs-material/reference/tooltips/) - abbr - attr_list - # Include files in other documents like {!some/dir/in/docs/filename.md!} - - markdown_include.include: - base_path: docs - pymdownx.snippets: # auto_append abbreviations.md to every file # https://squidfunk.github.io/mkdocs-material/reference/tooltips/#adding-a-glossary auto_append: - docs/abbreviations.md - # Include files in other documents like {!some/dir/in/docs/filename.md!} # Metadata support in pages # (https://squidfunk.github.io/mkdocs-material/extensions/metadata/) - meta diff --git a/requirements.txt b/requirements.txt index 424e520..a423151 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,3 @@ zensical==0.0.8 mkdocs-git-revision-date-localized-plugin==1.5.0 mkdocs-redirects==1.2.2 -markdown-include==0.8.1