Use Duckquill for docs

.github/workflows/pages.yml

@@ -0,0 +1,33 @@
+name: Zola on GitHub Pages
+
+on:
+  push:
+    branches:
+      - release
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    if: github.ref != 'refs/heads/release'
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Build only
+        uses: shalzz/[email protected]
+        env:
+          BUILD_DIR: docs
+          BUILD_ONLY: true
+
+  build_and_deploy:
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/release'
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Build and deploy
+        uses: shalzz/[email protected]
+        env:
+          BUILD_DIR: docs
+          PAGES_BRANCH: gh-pages
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -1,3 +1,4 @@
 tags
 *.vim
 TODO.txt
+docs/public/

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "docs/themes/duckquill"]
+	path = docs/themes/duckquill
+	url = https://codeberg.org/daudix/duckquill.git

CONTRIBUTING.md

@@ -95,7 +95,7 @@ done
   - `bashate -i E002,E003,E010,E011 --max-line-length 120`
 - use `markdownlint`
   - install using `npm -i -g markdownlint-cli`
-  - run `markdownlint $(find . -name '*.md' | grep -vF './.git')`
+  - run `markdownlint $(find . -name '*.md' | grep -vF './.git') --ignore docs/themes/duckquill/`
 - Legibility of the code is more important than code golfing, try to be
   expressive in the code
 - Try to **follow the happy path**:

distrobox-create

@@ -212,7 +212,7 @@ Options:
 	--pre-init-hooks:	additional commands to execute at the start of container initialization
 	--init/-I:		use init system (like systemd) inside the container.
 				this will make host's processes not visible from within the container. (assumes --unshare-process)
-				may require additional packages depending on the container image: https://github.com/89luca89/distrobox/blob/main/docs/useful_tips.md#using-init-system-inside-a-distrobox
+				may require additional packages depending on the container image: https://github.com/89luca89/distrobox/blob/main/docs/content/useful_tips.md#using-init-system-inside-a-distrobox
 	--nvidia:		try to integrate host's nVidia drivers in the guest
 	--unshare-devsys:          do not share host devices and sysfs dirs from host
 	--unshare-groups:          do not forward user's additional groups into the container
@@ -235,7 +235,7 @@ Compatibility:
 		man distrobox-compatibility
 	or run
 		distrobox create --compatibility
-	or consult the documentation page on: https://github.com/89luca89/distrobox/blob/main/docs/compatibility.md
+	or consult the documentation page on: https://github.com/89luca89/distrobox/blob/main/docs/content/compatibility.md
 EOF
 }
 
@@ -537,7 +537,7 @@ if ! command -v "${container_manager}" > /dev/null && [ "${dryrun}" -eq 0 ]; the
 	printf >&2 "You can follow the documentation on:\n"
 	printf >&2 "\tman distrobox-compatibility\n"
 	printf >&2 "or:\n"
-	printf >&2 "\thttps://github.com/89luca89/distrobox/blob/main/docs/compatibility.md\n"
+	printf >&2 "\thttps://github.com/89luca89/distrobox/blob/main/docs/content/compatibility.md\n"
 	exit 127
 fi
 # add  verbose if -v is specified

distrobox-enter

@@ -331,7 +331,7 @@ if ! command -v "${container_manager}" > /dev/null && [ "${dryrun}" -eq 0 ]; the
 	printf >&2 "You can follow the documentation on:\n"
 	printf >&2 "\tman distrobox-compatibility\n"
 	printf >&2 "or:\n"
-	printf >&2 "\thttps://github.com/89luca89/distrobox/blob/main/docs/compatibility.md\n"
+	printf >&2 "\thttps://github.com/89luca89/distrobox/blob/main/docs/content/compatibility.md\n"
 	exit 127
 fi
 

distrobox-generate-entry

@@ -265,7 +265,7 @@ if ! command -v "${container_manager}" > /dev/null; then
 	printf >&2 "You can follow the documentation on:\n"
 	printf >&2 "\tman distrobox-compatibility\n"
 	printf >&2 "or:\n"
-	printf >&2 "\thttps://github.com/89luca89/distrobox/blob/main/docs/compatibility.md\n"
+	printf >&2 "\thttps://github.com/89luca89/distrobox/blob/main/docs/content/compatibility.md\n"
 	exit 127
 fi
 
@@ -300,24 +300,24 @@ if [ "${icon}" = "auto" ]; then
 	# This is a NON comprehensive list of logos of the most popular distributions. If you find logos for
 	# other supported distros, add it here.
 	DISTRO_ICON_MAP="
-		alma:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/assets/png/distros/alma-distrobox.png
-		alpine:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/assets/png/distros/alpine-distrobox.png
-		arch:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/assets/png/distros/arch-distrobox.png
-		centos:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/assets/png/distros/centos-distrobox.png
-		clear--os:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/assets/png/distros/clear-distrobox.png
-		debian:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/assets/png/distros/debian-distrobox.png
-		deepin:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/assets/png/distros/deepin-distrobox.png
-		fedora:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/assets/png/distros/fedora-distrobox.png
-		gentoo:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/assets/png/distros/gentoo-distrobox.png
-		kali:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/assets/png/distros/kali-distrobox.png
-		kdeneon:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/assets/png/distros/kdeneon-distrobox.png
-		opensuse-leap:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/assets/png/distros/opensuse-distrobox.png
-		opensuse-tumbleweed:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/assets/png/distros/opensuse-distrobox.png
-		rhel:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/assets/png/distros/redhat-distrobox.png
-		rocky:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/assets/png/distros/rocky-distrobox.png
-		ubuntu:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/assets/png/distros/ubuntu-distrobox.png
-		vanilla:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/assets/png/distros/vanilla-distrobox.png
-		void:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/assets/png/distros/void-distrobox.png
+		alma:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/static/assets/distros/alma-distrobox.png
+		alpine:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/static/assets/distros/alpine-distrobox.png
+		arch:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/static/assets/distros/arch-distrobox.png
+		centos:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/static/assets/distros/centos-distrobox.png
+		clear--os:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/static/assets/distros/clear-distrobox.png
+		debian:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/static/assets/distros/debian-distrobox.png
+		deepin:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/static/assets/distros/deepin-distrobox.png
+		fedora:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/static/assets/distros/fedora-distrobox.png
+		gentoo:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/static/assets/distros/gentoo-distrobox.png
+		kali:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/static/assets/distros/kali-distrobox.png
+		kdeneon:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/static/assets/distros/kdeneon-distrobox.png
+		opensuse-leap:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/static/assets/distros/opensuse-distrobox.png
+		opensuse-tumbleweed:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/static/assets/distros/opensuse-distrobox.png
+		rhel:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/static/assets/distros/redhat-distrobox.png
+		rocky:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/static/assets/distros/rocky-distrobox.png
+		ubuntu:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/static/assets/distros/ubuntu-distrobox.png
+		vanilla:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/static/assets/distros/vanilla-distrobox.png
+		void:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/static/assets/distros/void-distrobox.png
 	"
 	# Try to detect container's distribution by using /etc/os-release
 	${container_manager_cp_command} "${container_name}":/etc/os-release /tmp/"${container_name}".os-release

distrobox-list

@@ -210,7 +210,7 @@ if ! command -v "${container_manager}" > /dev/null; then
 	printf >&2 "You can follow the documentation on:\n"
 	printf >&2 "\tman distrobox-compatibility\n"
 	printf >&2 "or:\n"
-	printf >&2 "\thttps://github.com/89luca89/distrobox/blob/main/docs/compatibility.md\n"
+	printf >&2 "\thttps://github.com/89luca89/distrobox/blob/main/docs/content/compatibility.md\n"
 	exit 127
 fi
 # add verbose if -v is specified

distrobox-rm

@@ -251,7 +251,7 @@ if ! command -v "${container_manager}" > /dev/null; then
 	printf >&2 "You can follow the documentation on:\n"
 	printf >&2 "\tman distrobox-compatibility\n"
 	printf >&2 "or:\n"
-	printf >&2 "\thttps://github.com/89luca89/distrobox/blob/main/docs/compatibility.md\n"
+	printf >&2 "\thttps://github.com/89luca89/distrobox/blob/main/docs/content/compatibility.md\n"
 	exit 127
 fi
 

distrobox-stop

@@ -242,7 +242,7 @@ if ! command -v "${container_manager}" > /dev/null; then
 	printf >&2 "You can follow the documentation on:\n"
 	printf >&2 "\tman distrobox-compatibility\n"
 	printf >&2 "or:\n"
-	printf >&2 "\thttps://github.com/89luca89/distrobox/blob/main/docs/compatibility.md\n"
+	printf >&2 "\thttps://github.com/89luca89/distrobox/blob/main/docs/content/compatibility.md\n"
 	exit 127
 fi
 # add  verbose if -v is specified

distrobox-upgrade

@@ -231,7 +231,7 @@ if ! command -v "${container_manager}" > /dev/null; then
 	printf >&2 "You can follow the documentation on:\n"
 	printf >&2 "\tman distrobox-compatibility\n"
 	printf >&2 "or:\n"
-	printf >&2 "\thttps://github.com/89luca89/distrobox/blob/main/docs/compatibility.md\n"
+	printf >&2 "\thttps://github.com/89luca89/distrobox/blob/main/docs/content/compatibility.md\n"
 	exit 127
 fi