Switch to Duckquill for documentation

.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: site
+          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: site
+          PAGES_BRANCH: gh-pages
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

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

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "site/themes/duckquill"]
+	path = site/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 site/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**:

README.md

@@ -0,0 +1,44 @@
+<p align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="static/assets/brand/png/distrobox-dark.png" />
+    <img alt="Distrobox logo" src="static/assets/brand/png/distrobox-light.png" width="400" height="200" />
+  </picture>
+</p>
+
+<p align="center">
+  <strong>Use any linux distribution inside your terminal.</strong>
+</p>
+
+---
+
+[![Lint](https://github.com/89luca89/distrobox/actions/workflows/main.yml/badge.svg)](https://github.com/89luca89/distrobox/actions/workflows/main.yml)
+[![CI](https://github.com/89luca89/distrobox/actions/workflows/compatibility.yml/badge.svg)](https://github.com/89luca89/distrobox/actions/workflows/compatibility.yml)
+[![GitHub](https://img.shields.io/github/license/89luca89/distrobox?color=blue)](https://github.com/89luca89/distrobox/blob/main/COPYING.md)
+[![GitHub release (latest by date)](https://img.shields.io/github/v/release/89luca89/distrobox)](https://github.com/89luca89/distrobox/releases/latest)
+[![Packaging status](https://repology.org/badge/tiny-repos/distrobox.svg)](https://repology.org/project/distrobox/versions)
+[![GitHub issues by-label](https://img.shields.io/github/issues-search/89luca89/distrobox?query=is%3Aissue%20is%3Aopen%20label%3Abug%20-label%3Await-on-user%20&label=Open%20Bug%20Reports&color=red)](https://github.com/89luca89/distrobox/issues?q=is%3Aissue+is%3Aopen+label%3Abug+-label%3Await-on-user)
+
+[Matrix Room](https://matrix.to/#/%23distrobox:matrix.org) - [Telegram Group](https://t.me/distrobox)
+
+Use any Linux distribution inside your terminal. Enable both backward and forward
+compatibility with software and freedom to use whatever distribution you’re more comfortable with.
+
+Distrobox uses `podman`, `docker` or [`lilipod`](https://github.com/89luca89/lilipod) to create containers
+using the Linux distribution of your choice. The created container will be tightly integrated with the
+host, allowing sharing of the HOME directory of the user, external storage, external USB devices and
+graphical apps (X11/Wayland), and audio.
+
+![overview](https://user-images.githubusercontent.com/598882/144294862-f6684334-ccf4-4e5e-85f8-1d66210a0fff.png)
+
+## Documentation
+
+Documentation for the [latest release](https://github.com/89luca89/distrobox/releases/latest) is available
+over at [distrobox.it](https://distrobox.it). Documentation in the `docs/` directory on GitHub strictly
+refers to the code in the main branch and is not optimized for being viewed without building it as the website.
+
+To build the website:
+
+1. Clone this repository recursively: `git clone --recursive https://github.com/89luca89/distrobox.git`
+2. Install [Zola](https://www.getzola.org) >= v0.19.2.
+3. Enter the `site` directory.
+4. Run `zola serve`

distrobox-generate-entry

@@ -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/site/static/assets/distros/alma-distrobox.png
+		alpine:https://raw.githubusercontent.com/89luca89/distrobox/main/site/static/assets/distros/alpine-distrobox.png
+		arch:https://raw.githubusercontent.com/89luca89/distrobox/main/site/static/assets/distros/arch-distrobox.png
+		centos:https://raw.githubusercontent.com/89luca89/distrobox/main/site/static/assets/distros/centos-distrobox.png
+		clear--os:https://raw.githubusercontent.com/89luca89/distrobox/main/site/static/assets/distros/clear-distrobox.png
+		debian:https://raw.githubusercontent.com/89luca89/distrobox/main/site/static/assets/distros/debian-distrobox.png
+		deepin:https://raw.githubusercontent.com/89luca89/distrobox/main/site/static/assets/distros/deepin-distrobox.png
+		fedora:https://raw.githubusercontent.com/89luca89/distrobox/main/site/static/assets/distros/fedora-distrobox.png
+		gentoo:https://raw.githubusercontent.com/89luca89/distrobox/main/site/static/assets/distros/gentoo-distrobox.png
+		kali:https://raw.githubusercontent.com/89luca89/distrobox/main/site/static/assets/distros/kali-distrobox.png
+		kdeneon:https://raw.githubusercontent.com/89luca89/distrobox/main/site/static/assets/distros/kdeneon-distrobox.png
+		opensuse-leap:https://raw.githubusercontent.com/89luca89/distrobox/main/site/static/assets/distros/opensuse-distrobox.png
+		opensuse-tumbleweed:https://raw.githubusercontent.com/89luca89/distrobox/main/site/static/assets/distros/opensuse-distrobox.png
+		rhel:https://raw.githubusercontent.com/89luca89/distrobox/main/site/static/assets/distros/redhat-distrobox.png
+		rocky:https://raw.githubusercontent.com/89luca89/distrobox/main/site/static/assets/distros/rocky-distrobox.png
+		ubuntu:https://raw.githubusercontent.com/89luca89/distrobox/main/site/static/assets/distros/ubuntu-distrobox.png
+		vanilla:https://raw.githubusercontent.com/89luca89/distrobox/main/site/static/assets/distros/vanilla-distrobox.png
+		void:https://raw.githubusercontent.com/89luca89/distrobox/main/site/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