docs: Add mkdocs skeleton

ublue-os · KyleGospo · Aug 28, 2024 · Jul 31, 2024 · Jul 31, 2024 · Jul 31, 2024
commit f3373221da2ded3d181310492028a742523d3430
@@ -176,3 +176,4 @@ poetry.toml
 pyrightconfig.json
 
 # End of https://www.toptal.com/developers/gitignore/api/python
+*.code-workspace
diff --git a/docs/docs/index.md b/docs/docs/index.md
@@ -0,0 +1,17 @@
+# Welcome to MkDocs
+
+For full documentation visit [mkdocs.org](https://www.mkdocs.org).
+
+## Commands
+
+* `mkdocs new [dir-name]` - Create a new project.
+* `mkdocs serve` - Start the live-reloading docs server.
+* `mkdocs build` - Build the documentation site.
+* `mkdocs -h` - Print help message and exit.
+
+## Project layout
+
+    mkdocs.yml    # The configuration file.
+    docs/
+        index.md  # The documentation homepage.
+        ...       # Other markdown pages, images and other files.
@@ -0,0 +1,23 @@
+from copy import copy
+import re
+import shlex
+import subprocess
+
+
+CMDRUN_PATTERN = r"<!--\s?cmdrun\s(.*)-->"
+
+
+def _cmdrun_sub_handler(match: re.Match) -> str:
+    cmd = match.group(1)
+    proc = subprocess.run(shlex.split(cmd), capture_output=True, text=True)
+    return proc.stdout.strip()
+
+
+def on_page_markdown(markdown: str, **kargs):
+    markdown_orig = markdown
+    result = copy(markdown_orig)
+
+    # First find all iterations of `<!-- cmdrun whatevercommand -->`
+    result = re.sub(CMDRUN_PATTERN, _cmdrun_sub_handler, markdown_orig)
+
+    return result
@@ -0,0 +1,34 @@
+site_name: Bazzite Documentation
+site_author: nicknamenamenick
+site_url: !ENV MKDOCS_SITE_URL
+
+theme:
+  name: material
+  palette:
+    - media: "(prefers-color-scheme)"
+      toggle:
+        icon: material/brightness-auto
+        name: Switch to light mode
+
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      toggle:
+        icon: material/brightness-4
+        name: Switch to system preference
+
+  favicon: img/favicon.svg
+  logo: img/logo_BW.svg
+
+docs_dir: src
+site_dir: book
+
+plugins:
+  - search
+  - offline:
+      enabled: !ENV [MKDOCS_OFFLINE, false]
@@ -0,0 +1,19 @@
+[tool.poetry]
+name = "bazzite-docs"
+version = "0.1.0"
+description = ""
+authors = ["Zeglius <33781398+Zeglius@users.noreply.github.com>"]
+readme = "README.md"
+package-mode = false
+
+[tool.poetry.dependencies]
+python = "^3.12"
+mkdocs = "^1.6.0"
+requests = "^2.32.3"
+mkdocs-material = "^9.5.32"
+mkdocs-with-pdf = "^0.9.3"
+
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
Original file line number	Diff line number	Diff line change
Expand Up		@@ -176,3 +176,4 @@ poetry.toml
		pyrightconfig.json

		# End of https://www.toptal.com/developers/gitignore/api/python
		*.code-workspace