⬆️ Migrate to Zensical

docs/contributing.md

@@ -241,10 +241,10 @@ Go into the docs directory at `docs/`:
 $ cd docs/
 ```
 
-Then run `mkdocs` in that directory:
+Then run `zensical` in that directory:
 
 ```console
-$ mkdocs serve --dev-addr 8008
+$ zensical serve --dev-addr 8008
 ```
 
 ///
@@ -270,7 +270,7 @@ Completion will take effect once you restart the terminal.
 
 ### Docs Structure
 
-The documentation uses <a href="https://www.mkdocs.org/" class="external-link" target="_blank">MkDocs</a>.
+The documentation uses <a href="https://zensical.org" class="external-link" target="_blank">Zensical</a>.
 
 And there are extra tools/scripts in place in `./scripts/docs.py`.
 

mkdocs.yml

@@ -4,6 +4,7 @@ site_description: Typer, build great CLIs. Easy to code. Based on Python type hi
 site_url: https://typer.tiangolo.com/
 
 theme:
+  variant: classic
   name: material
   custom_dir: docs/overrides
   palette:
@@ -71,7 +72,7 @@ plugins:
 nav:
   - Typer: index.md
   - features.md
-  - Tutorial - User Guide:
+  - Learn:
       - tutorial/index.md
       - environment-variables.md
       - virtual-environments.md

pyproject.toml

@@ -70,6 +70,7 @@ docs = [
     "mkdocstrings[python]==0.30.1",
     "pillow==11.3.0",
     "pyyaml>=5.3.1,<7.0.0",
+    "zensical==0.0.15",
 ]
 github-actions = [
     "httpx>=0.27.0,<0.29.0",

scripts/docs.py

@@ -80,7 +80,7 @@ def live(dirty: bool = False) -> None:
     en.
     """
     # Enable line numbers during local development to make it easier to highlight
-    args = ["mkdocs", "serve", "--dev-addr", "127.0.0.1:8008"]
+    args = ["zensical", "serve", "--dev-addr", "127.0.0.1:8008"]
     if dirty:
         args.append("--dirty")
     subprocess.run(args, env={**os.environ, "LINENUMS": "true"}, check=True)
@@ -92,7 +92,7 @@ def build() -> None:
     Build the docs.
     """
     print("Building docs")
-    subprocess.run(["mkdocs", "build"], check=True)
+    subprocess.run(["zensical", "build"], check=True)
     typer.secho("Successfully built docs", color=typer.colors.GREEN)
 
 
@@ -101,7 +101,7 @@ def serve() -> None:
     """
     A quick server to preview a built site.
 
-    For development, prefer the command live (or just mkdocs serve).
+    For development, prefer the command live (or just zensical serve).
 
     This is here only to preview the documentation site.