Use mkdocs2 for documentation builds (#135)

lovelydinosaur · web-flow · commit b179e88cc849 · 2026-02-20T14:52:09.000Z
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -0,0 +1,28 @@
+name: Documentation
+on:
+  push:
+    branches:
+        - dev
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/configure-pages@v5
+      - uses: actions/checkout@v5
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: pip install -r requirements.txt
+      - run: mkdocs build
+      - uses: actions/upload-pages-artifact@v4
+        with:
+          path: site
+      - uses: actions/deploy-pages@v4
+        id: deployment
diff --git a/.gitignore b/.gitignore
@@ -5,4 +5,4 @@
 __pycache__/
 dist/
 venv/
-build/
+site/
diff --git a/README.md b/README.md
@@ -59,14 +59,4 @@ The [HTTPX 1.0 design proposal](https://www.encode.io/httpnext/) is now availabl
 
 ---
 
-# Collaboration
-
-The repository for this project is currently private.
-
-We’re looking at creating paid opportunities for working on open source software *which are properly compensated, flexible & well balanced.*
-
-If you're interested in a position working on this project, please <a href="mailto:kim@encode.io">send an intro</a>.
-
----
-
 <p align="center"><i>This provisional design work is <a href="https://github.com/encode/httpnext/blob/master/LICENSE.md">not currently licensed</a> for reuse.<br/>Designed & crafted with care.</i><br/>&mdash; 🦋 &mdash;</p>
diff --git a/docs/templates/base.html b/docs/templates/base.html
@@ -86,6 +86,12 @@
             color: #474747;
         }
 
+        h1 a, h2 a, h3 a, h4 a {
+            color: #eee;
+            font-weight: 300;
+            text-decoration: none;
+        }
+
         h1 { text-align: center; font-weight: 300; font-size: 4rem; }
         h2 { font-size: 2rem; }
         h3 { font-size: 1.5rem; }
@@ -174,7 +180,7 @@
 </head>
 <body>
     <main>
-        {{ content }}
+        {{ page.html }}
     </main>
     <script>
         document.addEventListener('DOMContentLoaded', function() {
@@ -183,4 +189,4 @@
             }
         })
     </script>
-</body></html>
+</body></html>
diff --git a/mkdocs.toml b/mkdocs.toml
@@ -0,0 +1,6 @@
+[mkdocs]
+nav = []
+
+[loaders]
+theme = "dir://docs"
+docs = "dir://docs"
diff --git a/requirements.txt b/requirements.txt
@@ -12,6 +12,4 @@ pytest-cov==6.1.1
 unasync==0.6.0
 
 # Documentation...
-click==8.2.1
-jinja2==3.1.6
-markdown==3.8
+git+https://github.com/encode/mkdocs.git
diff --git a/scripts/docs b/scripts/docs

-Original file line number
+Diff line change
 __pycache__/
 dist/
 venv/
 -build/
 +site/