docs

.github/workflows/push_main.yml

@@ -0,0 +1,16 @@
+jobs:
+  mkdocs:
+    runs-on: "ubuntu-latest"
+    steps:
+      - uses: "actions/checkout@v4"
+      - uses: "actions/setup-python@v5"
+        with:
+          python-version: "3.x"
+      - run: "python -m pip install --upgrade mkdocs-material"
+#on:
+#  push:
+#    branches:
+#      - "main"
+on: "push"
+permissions:
+  contents: "write"

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.

mkdocs.yml

@@ -0,0 +1,3 @@
+site_name: "Beignet"
+theme:
+  name: "material"