chore: add GitHub Actions workflow for deployment and update project configurations

Author: Eoic

.github/workflows/deploy.yml

@@ -0,0 +1,46 @@
+name: Deploy
+
+on:
+  push:
+    branches: [master]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          cache: pip
+
+      - name: Install dependencies
+        run: pip install -e .
+
+      - name: Build site
+        run: zensical build
+
+      - uses: actions/upload-pages-artifact@v3
+        with:
+          path: site/
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - id: deployment
+        uses: actions/deploy-pages@v4

Makefile

@@ -1,4 +1,4 @@
-.PHONY: help install install-dev serve build deploy clean lint
+.PHONY: help install install-dev serve build clean lint
 
 help:
 	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | \
@@ -11,17 +11,14 @@ install-dev:
 	pip install -e ".[dev]"
 
 serve: 
-	mkdocs serve
+	zensical serve
 
 build:
-	mkdocs build --strict
-
-deploy: 
-	mkdocs gh-deploy --force
+	zensical build
 
 clean: 
 	rm -rf site/
 
 lint: 
-	mkdocs build --strict
+	zensical build
 	linkchecker site/index.html --check-extern --no-warnings

mkdocs.yml

@@ -1,10 +1,10 @@
 site_name: Papyrus Documentation
 site_description: Cross-platform e-book management application
 site_author: Papyrus
-site_url: https://papyrus.example.com/docs/
+site_url: https://papyrusreader.github.io/docs/
 repo_name: Papyrus
-repo_url: https://github.com/Eoic/Papyrus
-edit_uri: edit/master/docs/src/
+repo_url: https://github.com/PapyrusReader/client
+edit_uri: edit/master/src/
 docs_dir: src
 site_dir: site
 
@@ -49,8 +49,6 @@ theme:
 plugins:
   - search:
       separator: '[\s\-\.]+'
-  - minify:
-      minify_html: true
 
 exclude_docs: |
   SUMMARY.md

pyproject.toml

@@ -6,17 +6,10 @@ readme = "README.md"
 license = { text = "MIT" }
 requires-python = ">=3.10"
 
-dependencies = [
-    "mkdocs>=1.6",
-    "mkdocs-material>=9.5",
-    "mkdocs-minify-plugin>=0.8",
-    "mkdocs-swagger-ui-tag>=0.6",
-    "pymdown-extensions>=10.0",
-    "pygments>=2.17",
-]
+dependencies = ["zensical>=0.0.24", "mkdocs-swagger-ui-tag>=0.6"]
 
 [project.optional-dependencies]
-dev = ["mike>=2.1", "linkchecker>=10.0"]
+dev = ["linkchecker>=10.0"]
 
 [build-system]
 requires = ["setuptools>=68.0"]

src/stylesheets/extra.css

@@ -34,6 +34,32 @@
 
 .md-header {
   background-color: var(--md-primary-fg-color);
+  color: var(--md-primary-bg-color);
+}
+
+.md-header .md-icon,
+.md-header .md-header__button {
+  color: var(--md-primary-bg-color);
+}
+
+.md-header__topic {
+  color: var(--md-primary-bg-color);
+}
+
+.md-search__button {
+  color: var(--md-primary-bg-color);
+}
+
+.md-header .md-search__icon svg,
+.md-header .md-search__button svg {
+  fill: var(--md-primary-bg-color);
+}
+
+.md-header a:hover,
+.md-header .md-header__topic:hover,
+.md-header .md-search__button:hover {
+  color: var(--md-primary-bg-color);
+  opacity: 0.8;
 }
 
 .swagger-ui-wrap {
@@ -96,4 +122,12 @@
 [data-md-color-scheme="slate"] .swagger-ui .highlight-code,
 [data-md-color-scheme="slate"] .swagger-ui pre {
   filter: invert(100%) hue-rotate(180deg);
+}
+
+.md-header .md-search__button::before {
+  background-color: white;
+}
+
+.md-header .md-search__button::after {
+  background-color: hsla(var(--md-hue), 15%, 5%, 0.54);
 }