--no-ipv6
+ ```
diff --git a/docs/content/guides/clients.md b/docs/content/guides/clients.md
index 6314adac..e4ecb502 100644
--- a/docs/content/guides/clients.md
+++ b/docs/content/guides/clients.md
@@ -23,11 +23,9 @@ Use the Firewall Allowed IPs feature to prevent access to IP ranges that the use
## Firewall Allowed IPs
-/// note | Attention
+!!! note "Attention"
-This field only appears when **Per-Client Firewall** is enabled in the Admin Panel → Interface settings.
-
-///
+ This field only appears when **Per-Client Firewall** is enabled in the Admin Panel → Interface settings.
Server-side firewall rules that restrict which destinations the client can access, regardless of their local configuration.
@@ -46,14 +44,12 @@ Unlike "Allowed IPs" which only controls routing on the client side, these rules
- `[2001:db8::1]:443` - IPv6 address with port (brackets required)
- `[2001:db8::/32]:443/tcp` - IPv6 CIDR with port and protocol
-/// warning | Invalid Formats
-
-Protocol specifiers (`/tcp` or `/udp`) require a port number. The following formats are **not supported** and will result in an error:
+!!! warning "Invalid Formats"
-- `10.10.0.3/tcp` (use `10.10.0.3:443/tcp` instead)
-- `10.10.0.0/24/udp` (use `10.10.0.0/24:53/udp` instead)
+ Protocol specifiers (`/tcp` or `/udp`) require a port number. The following formats are **not supported** and will result in an error:
-///
+ - `10.10.0.3/tcp` (use `10.10.0.3:443/tcp` instead)
+ - `10.10.0.0/24/udp` (use `10.10.0.0/24:53/udp` instead)
**Behavior:**
@@ -61,9 +57,9 @@ Protocol specifiers (`/tcp` or `/udp`) require a port number. The following form
- **Specified**: Only listed destinations are accessible (allow-only, everything else is blocked)
- **Disable for specific client**: To disable firewall filtering for a single client while keeping it enabled for others, add `0.0.0.0/0, ::/0` to allow all traffic
-/// note
-To allow clients to reach the VPN server itself (e.g. for DNS), include the server's VPN address in the firewall allowed IPs.
-///
+!!! note
+
+ To allow clients to reach the VPN server itself (e.g. for DNS), include the server's VPN address in the firewall allowed IPs.
**Use Case Examples**:
diff --git a/docs/content/index.md b/docs/content/index.md
index e15fd9c0..809a4afa 100644
--- a/docs/content/index.md
+++ b/docs/content/index.md
@@ -1,20 +1,15 @@
---
title: Home
-hide:
- - navigation
---
# Welcome to the Documentation for `wg-easy`
-/// info | This Documentation is Versioned
+!!! info "This Documentation is Versioned"
-**Make sure** to select the correct version of this documentation! It should match the version of the image you are using. The default version corresponds to [the most recent stable release][docs-tagging].
-///
+ **Make sure** to select the correct version of this documentation! It should match the version of the image you are using. The default version corresponds to [the most recent stable release](./getting-started.md#tagging-convention).
This documentation provides you not only with the basic setup and configuration of `wg-easy` but also with advanced configuration, elaborate usage scenarios, detailed examples, hints and more.
-[docs-tagging]: ./getting-started.md#tagging-convention
-
## About
`wg-easy` is the easiest way to run WireGuard VPN + Web-based Admin UI.
diff --git a/docs/zensical.toml b/docs/zensical.toml
new file mode 100644
index 00000000..e0126426
--- /dev/null
+++ b/docs/zensical.toml
@@ -0,0 +1,97 @@
+[project]
+site_name = "wg-easy"
+site_description = "The easiest way to run WireGuard VPN + Web-based Admin UI."
+site_author = "WireGuard Easy"
+copyright = """
+
+© Wireguard Easy
+This project is licensed under AGPL-3.0-only.
+This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with Jason A. Donenfeld, ZX2C4 or Edge Security
+"WireGuard" and the "WireGuard" logo are registered trademarks of Jason A. Donenfeld
+
+"""
+
+repo_url = "https://github.com/wg-easy/wg-easy"
+repo_name = "wg-easy"
+
+edit_uri = "edit/master/docs/content"
+
+docs_dir = "content/"
+
+site_url = "https://wg-easy.github.io/wg-easy"
+
+extra_css = ["assets/stylesheets/extra.css"]
+
+[project.theme]
+variant = "modern"
+favicon = "assets/logo/favicon.png"
+logo = "assets/logo/logo.png"
+features = [
+ "navigation.instant",
+ "navigation.tabs",
+ "navigation.expand",
+ "navigation.path",
+ "navigation.top",
+ "content.action.edit",
+ "content.action.view",
+ "content.code.copy",
+ "content.code.annotate",
+]
+font = false
+
+[project.theme.icon]
+repo = "fontawesome/brands/github"
+
+# Palette toggle for automatic mode
+[[project.theme.palette]]
+media = "(prefers-color-scheme)"
+toggle.icon = "lucide/sun-moon"
+toggle.name = "Switch to light mode"
+
+# Palette toggle for light mode
+[[project.theme.palette]]
+media = "(prefers-color-scheme: light)"
+scheme = "default"
+primary = "grey"
+accent = "red"
+toggle.icon = "lucide/sun"
+toggle.name = "Switch to dark mode"
+
+# Palette toggle for dark mode
+[[project.theme.palette]]
+media = "(prefers-color-scheme: dark)"
+scheme = "slate"
+primary = "grey"
+accent = "red"
+toggle.icon = "lucide/moon"
+toggle.name = "Switch to system preference"
+
+[project.extra.version]
+provider = "mike"
+
+[project.markdown_extensions.admonition]
+
+[project.markdown_extensions.md_in_html]
+
+[project.markdown_extensions.toc]
+permalink = true
+
+[project.markdown_extensions.pymdownx.details]
+
+[project.markdown_extensions.pymdownx.emoji]
+emoji_generator = "zensical.extensions.emoji.to_svg"
+emoji_index = "zensical.extensions.emoji.twemoji"
+
+[project.markdown_extensions.pymdownx.highlight]
+anchor_linenums = true
+line_spans = "__span"
+pygments_lang_class = true
+
+[project.markdown_extensions.pymdownx.inlinehilite]
+
+[project.markdown_extensions.pymdownx.smartsymbols]
+
+[project.markdown_extensions.pymdownx.superfences]
+custom_fences = [
+ { name = "mermaid", class = "mermaid", format = "pymdownx.superfences.fence_code_format" },
+]
diff --git a/package.json b/package.json
index d95f8df9..78716d30 100644
--- a/package.json
+++ b/package.json
@@ -6,6 +6,7 @@
"cli:dev": "docker compose -f docker-compose.dev.yml run --build --rm -it wg-easy cli:dev",
"build": "docker build -t wg-easy .",
"docs:preview": "docker run --rm -it -p 8080:8080 -v ./docs:/docs squidfunk/mkdocs-material serve -a 0.0.0.0:8080",
+ "docs:test": "docker run --rm -it -p 8080:8080 -v ./docs:/docs zensical/zensical serve -a 0.0.0.0:8080",
"scripts:version": "bash scripts/version.sh",
"scripts:i18n": "bash scripts/i18n.sh",
"format:check:docs": "prettier --check docs"