Merge pull request #23 from encode/tweak-docs

lovelydinosaur · web-flow · commit a09564f873d5 · 2026-01-27T13:51:28.000Z
Tweak docs
diff --git a/docs/index.md b/docs/index.md
@@ -50,6 +50,6 @@ Styling adaptations can be kept simple, such as customising the colour scheme, o
 1. Modify [the HTML templating](styling.md#templates) to customise the layout.
 2. Override or add [CSS and JavaScript](styling.md#statics) static assets.
 
-## Compatability
+## Compatibility
 
-*Work is planned to handle compatability for both [mkdocs 2.x](https://www.encode.io/mkdocs/) sites, and [mkdocs 1.x](https://www.mkdocs.org/) sites.*
+*Work is planned to handle compatibility for both [mkdocs 2.x](https://www.encode.io/mkdocs/) sites, and [mkdocs 1.x](https://www.mkdocs.org/) sites.*
diff --git a/docs/navigation.md b/docs/navigation.md
@@ -70,13 +70,17 @@ A standard documentation site...
 | `navigation.md`   | `navigation/index.html` | `/navigation/` |
 | `styling.md`      | `styling/index.html`    | `/styling/`    |
 
+<br/>
+
 Uppercase filenames and GitHub style document paths...
 
 | **Markdown Page** | **HTML output**          | **URL**        |
 |-------------------|--------------------------|----------------|
 | `README.md`       | `index.html`             | `/`            |
 | `ABOUT.md`        | `about.html`             | `/about/`      |
 
+<br/>
+
 Documentation structure including subdirectories...
 
 | **Markdown Page**        | **HTML output**                  | **URL**                 |
diff --git a/docs/styling.md b/docs/styling.md
@@ -23,7 +23,7 @@ The base template for rendering markdown pages is **`templates/base.html`**.
     <head>
         <meta charset="utf-8">
         <meta name="viewport" content="width=device-width, initial-scale=1.0">
-        <title>{{ config.mkdocs.title or page.title }}</title>
+        <title>{{ nav.current.title or page.title }}{{ " - " ~ config.context.title if config.context.title }}</title>
         <link rel="icon" href="data:image/svg+xml,&lt;svg xmlns=&quot;http://www.w3.org/2000/svg&quot; viewBox=&quot;0 0 100 100&quot;&gt;&lt;text y=&quot;.9em&quot; font-size=&quot;90&quot;&gt;{{ config.mkdocs.favicon or '📘' }}&lt;/text&gt;&lt;/svg&gt;">
         <link rel="stylesheet" href="{{ '/css/highlightjs.min.css' | url }}">
         <link rel="stylesheet" href="{{ '/css/highlightjs-copy.min.css' | url }}">
@@ -133,7 +133,7 @@ resources = [
 ```toml
 [mkdocs]
 resources = [
-    {url="https://github.com/lovelydinosaur/test/archive/refs/heads/main.zip"},
+    {url="https://github.com/lovelydinosaur/mkdocs-theme/archive/refs/heads/main.zip"},
     {directory="docs"},
 ]
 ```
@@ -156,3 +156,5 @@ resources = [
     {directory="docs"},
 ]
 ```
+
+<br/>
diff --git a/src/mkdocs/mkdocs.py b/src/mkdocs/mkdocs.py
@@ -1,4 +1,6 @@
+import base64
 import io
+import json
 import pathlib
 import posixpath
 import typing
@@ -138,7 +140,8 @@ def __init__(self, url: str) -> None:
         self._topdir = ''
 
     def load_paths(self) -> list[pathlib.Path]:
-        r = httpx.get(self._url)
+        r = httpx.get(self._url, follow_redirects=True)
+        r.raise_for_status()
         b = io.BytesIO(r.content)
         with zipfile.ZipFile(b, 'r') as zip_ref:
             names = [
@@ -152,6 +155,7 @@ def load_paths(self) -> list[pathlib.Path]:
 
     def read(self, path: pathlib.Path) -> bytes:
         r = httpx.get(self._url, follow_redirects=True)
+        r.raise_for_status()
         b = io.BytesIO(r.content)
         with zipfile.ZipFile(b, 'r') as zip_ref:
             path = f"{self._topdir}/{path}" if self._topdir else path
@@ -223,11 +227,14 @@ class TemplateLoader(jinja2.BaseLoader):
     def __init__(self, templates: list[Template]):
         self.templates = templates
 
+    def uptodate(self):
+        return False
+
     def get_source(self, environment: jinja2.Environment, template: str):
         for t in self.templates:
             if t.name == template:
                 source = t.read().decode('utf-8')
-                return source, t.path, None
+                return source, t.path, self.uptodate
         raise jinja2.TemplateNotFound(template)
 
 
diff --git a/src/mkdocs/theme/templates/base.html b/src/mkdocs/theme/templates/base.html
@@ -2,8 +2,8 @@
     <head>
         <meta charset="utf-8">
         <meta name="viewport" content="width=device-width, initial-scale=1.0">
-        <title>{{ nav.current.title or page.title or config.mkdocs.site_title }}</title>
-        <link rel="icon" href="data:image/svg+xml,&lt;svg xmlns=&quot;http://www.w3.org/2000/svg&quot; viewBox=&quot;0 0 100 100&quot;&gt;&lt;text y=&quot;.9em&quot; font-size=&quot;90&quot;&gt;{{ config.mkdocs.favicon or '📘' }}&lt;/text&gt;&lt;/svg&gt;">
+        <title>{{ nav.current.title or page.title }}{{ " - " ~ config.context.title if config.context.title }}</title>
+        <link rel="icon" href="data:image/svg+xml,&lt;svg xmlns=&quot;http://www.w3.org/2000/svg&quot; viewBox=&quot;0 0 100 100&quot;&gt;&lt;text y=&quot;.9em&quot; font-size=&quot;90&quot;&gt;{{ config.context.favicon or '📘' }}&lt;/text&gt;&lt;/svg&gt;">
         <link rel="stylesheet" href="{{ '/css/highlightjs.min.css' | url }}">
         <link rel="stylesheet" href="{{ '/css/highlightjs-copy.min.css' | url }}">
         <link rel="stylesheet" href="{{ '/css/theme.css' | url }}">
