Configuration of MkDoc

This document describes the complete MkDocs configuration for the Scanframe Wiki documentation service, including Docker setup, PlantUML rendering, PWA manifest, CPU optimization, and custom styling.

Project Structure

The documentation project is organized across two main directories:

Directory	Purpose	Container Mount
mkdoc/	MkDocs configuration, Dockerfile, theme overrides, and static assets	/docs (read-only)
docroot/	Markdown content files (wiki, progress, miscellaneous)	/src (read-only)

The docroot/ directory contains symlinks or subdirectories for each content section:

• docroot/wiki/ — Wiki documentation pages.
• docroot/progress/ — Progress tracking pages.
• docroot/misc/ — Miscellaneous content.
• docroot/website/ — Production website content.

Docker Service

Dockerfile (mkdoc/Dockerfile)

The Dockerfile extends the squidfunk/mkdocs-material base image and adds:

1. Java runtime and Graphviz — Required for local PlantUML rendering.
2. PlantUML JAR — Downloaded to /opt/plantuml/plantuml.jar for offline diagram rendering.
3. Python packages — mkdocs-awesome-pages-plugin, mkdocs-glightbox, mkdocs-build-plantuml-plugin, and plantuml-markdown.
4. CPU optimization — The livereload polling interval is patched from 0.5 seconds to 600 seconds (10 minutes) to eliminate idle CPU usage.

Docker Compose (mkdoc/docker-compose.yml)

The service is defined in mkdoc/docker-compose.yml:

• Image: Built from the local Dockerfile.
• Port mapping: 127.0.0.1:8081 maps to container port 8000.
• Volumes: Two read-only mounts:
  • ../mkdoc → /docs (MkDocs configuration and static assets).
  • ../docroot → /src (Markdown content directories).
• Restart policy: unless-stopped ensures the service restarts on container restart.
• User: Runs as www-data (UID 33:33).

Starting the Service

Use the build.sh script from the project root:

Command	Description
build	Build the Docker image and start the service.
up	Start the service in the background.
down	Stop and remove the container.
restart	Restart the running container.
status	Show whether the container is running.
info	Show Docker image information.
prune	Remove unused Docker resources.
exec	Execute a command inside the container.

The site is available at http://127.0.0.1:8081.

Build Management Script (mkdoc/build.sh)

A symlinked script build.sh in the project root provides all Docker Compose commands for the MkDocs service. The actual script resides in mkdoc/build.sh and uses two directory variables:

• script_dir — Resolves to the actual script location (mkdoc/), used for finding docker-compose.yml.
• run_dir — Resolves to the directory from which the script was invoked (the symlink's location, i.e., the project root).

Available Commands

Command	Description
build	Build the Docker image and start the service.
restart	Restart the running container, triggering a full rebuild.
up	Start the service in the background.
down	Stop and remove the container.
status	Show whether the container is running and display stats using jq.
info	Show information about the Docker image.
prune	Remove unused Docker resources.
exec	Execute a command inside the running container, passing remaining args.
auto-restart	Watch documentation files and auto-restart the container on changes.
help	Show the help message.

Status Command

The status command uses jq to parse the NDJSON output from docker compose ps --format json, extracting the .State field to determine if the container is running.

Auto-Restart Command

The auto-restart command provides event-driven file watching with near-zero CPU usage as an alternative to manual rebuilds:

1. Builds watch list — Collects real paths (via readlink -f) of all entries in ${script_dir}/docs and the mkdocs.yml configuration file.
2. Watches for changes — Uses inotifywait to monitor for modify, create, delete, and move events across all watched paths.
3. Debounces — Waits 7 seconds after the last change before triggering a restart, so rapid saves trigger only one rebuild.
4. Restarts container — Executes docker compose restart to rebuild all pages.

./build.sh auto-restart

Requires inotify-tools package installed. The command runs in the foreground and can be stopped with Ctrl+C.

Manual Rebuilds

Due to the CPU optimization that disables file polling, automatic live reload is not available by default. Instead, use one of:

• ./build.sh restart — Restarts the container, forcing mkdocs serve to rebuild all pages from scratch on startup.
• ./build.sh auto-restart — Event-driven watching with automatic restarts and near-zero CPU usage.
• ./rebuild.sh — Legacy script that restarts the container via docker compose restart.

MkDocs Configuration (mkdoc/mkdocs.yml)

Site Metadata

Key	Value	Purpose
site_name	Scanframe Wiki	Browser tab title and homepage heading.
site_description	Public Wiki of Scanframe	SEO and social media preview text.
site_url	https://wiki.scanframe.com	Base URL for absolute links and sitemap.
dev_addr	0.0.0.0:8000	Binds to all interfaces so Docker port mapping works.

File Watching (Disabled)

The watch section is commented out to avoid high CPU usage from continuous file polling. Manual rebuilds via rebuild.sh are used instead.

Theme Configuration

The site uses Material for MkDocs with the following settings:

• Custom directory: overrides — Contains template overrides (e.g., the PWA manifest link).
• Favicon: assets/scanframe.ico.
• Logo: assets/scanframe.png.

Theme Features

Feature	Purpose
content.code.copy	Copy button on code blocks.
search.suggest	Autocomplete suggestions in the search box.
search.highlight	Highlights search matches on result pages.
search.share	Shareable search result URLs.
navigation.indexes	Allows landing pages for sections (index.md as section default).
content.code.annotate	Code block annotations via HTML comments.
content.tabs.link	Syncs code tab selections across pages in a session.

Color Palette

Two palettes are defined based on the user's OS-level color scheme preference:

• Light mode: default scheme with indigo primary and slate accent colors.
• Dark mode: slate scheme with indigo primary and slate accent colors.

Each palette includes a toggle button to switch to the other scheme.

Plugins

Plugin	Purpose
search	Built-in search index generation for the site search feature.
awesome-pages	Auto-generates navigation from directory structure using _navigate_.yml files. Sections with a single page are not collapsed.
glightbox	Lightbox gallery for images — click to view full-size with navigation.

Navigation Structure (mkdoc/docs/.pages.yml)

The awesome-pages plugin uses .pages.yml to define the navigation order:

nav:
    - 🌐 Website: website
    - 📢 Introduction: index.md
    - 📙 Wiki: wiki
    - 📈 Progress: progress
    - 📦 Miscellaneous: misc

Each entry maps a display title (with emoji prefix) to a content directory or file. Subdirectories are auto-discovered unless explicitly overridden with a .pages file in the target subdirectory.

Renaming Subdirectories

To rename a subdirectory in the navigation, create a .pages file in the target subdirectory with a title: field. For example, docroot/wiki/Configuration/.pages contains:

title: ⚙️ Configuration

This overrides the auto-discovered directory name in the navigation sidebar.

Emoji Title Prefixes

All Markdown documents in the content directories have emoji prefixes in their title: frontmatter field:

• docroot/progress/ — All 47 files prefixed with 🔵.
• docroot/wiki/ — All 146 files prefixed with 🟠.

Extra Configuration

• generator: false — Hides the "Powered by MkDocs" footer line.

Custom Stylesheets

• stylesheets/extra.css — Custom CSS that overrides theme defaults for font sizes, spacing, colors, and layout adjustments.

Custom JavaScript

File	Purpose
javascripts/external-links.js	Adds external link icons and target="_blank" to outbound links.
javascripts/hide-elements.js	Hides header, navigation sidebar, and footer on the production domain (www.scanframe.com) when the path starts with /website.

Markdown Extensions

Extension	Purpose
attr_list	Allows HTML attributes on Markdown elements (e.g., class, id).
md_in_html	Renders Markdown inside HTML blocks (e.g., <div> with Markdown content).
pymdownx.highlight	Syntax highlighting for fenced code blocks (Pygments-based) with line number anchors and custom CSS classes per language.
pymdownx.inlinehilite	Inline code highlighting with backticks and a language (e.g., `code { .python }).
pymdownx.snippets	Includes external files via {{ !path/to/file }} syntax.
pymdownx.superfences	Extended fenced code blocks with highlighting, line numbers, and titles.
pymdownx.tabbed	Tabbed content blocks for showing multiple code variants (alternate CSS style).

PlantUML Diagram Rendering

Overview

PlantUML diagrams are rendered offline using a local Java-based PlantUML JAR installed in the Docker container. No external network access is required.

Configuration

The plantuml_markdown extension is configured in mkdocs.yml:

- plantuml_markdown:
plantuml_cmd: 'java -Dplantuml.include.path=/src/progress:/src/wiki:/src/misc -jar /opt/plantuml/plantuml.jar'
format: 'svg'

• plantuml_cmd: Command to invoke PlantUML locally. The -Dplantuml.include.path JVM argument tells PlantUML where to resolve !include directives. The paths match the Docker volume mounts.
• format: Output format is svg (recommended for scalability).

Supported Patterns

Two PlantUML patterns are supported:

1. Inline diagrams — Diagram code written directly in a fenced code block:

   <img src="data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIiB2ZXJzaW9uPSIxLjEiIGRhdGEtZGlhZ3JhbS10eXBlPSJTRVFVRU5DRSIgc3R5bGU9IndpZHRoOjExN3B4O2hlaWdodDoxMzJweDtiYWNrZ3JvdW5kOiNGRkZGRkY7IiB3aWR0aD0iMTE3cHgiIGhlaWdodD0iMTMycHgiIHZpZXdCb3g9IjAgMCAxMTcgMTMyIiB6b29tQW5kUGFuPSJtYWduaWZ5IiBwcmVzZXJ2ZUFzcGVjdFJhdGlvPSJub25lIiBjb250ZW50U3R5bGVUeXBlPSJ0ZXh0L2NzcyI+PD9wbGFudHVtbCAxLjIwMjYuOT8+PGRlZnMvPjxnIGZvbnQtZmFtaWx5PSJzYW5zLXNlcmlmIiBsZW5ndGhBZGp1c3Q9InNwYWNpbmciPjxnIGNsYXNzPSJwYXJ0aWNpcGFudC1saWZlbGluZSIgZGF0YS1xdWFsaWZpZWQtbmFtZT0iQWxpY2UiIGRhdGEtZW50aXR5LXVpZD0icGFydDEiIGlkPSJwYXJ0MS1saWZlbGluZSIgZGF0YS1zb3VyY2UtbGluZT0iMiI+PGc+PHRpdGxlPkFsaWNlPC90aXRsZT48cmVjdCB4PSIyOC41MTUiIHk9IjQxLjgiIHdpZHRoPSI4IiBoZWlnaHQ9IjQ3LjYiIGZpbGw9IiMwMDAiIGZpbGwtb3BhY2l0eT0iMCIvPjxsaW5lIHgxPSIzMi4wMTUiIHkxPSI0MS44IiB4Mj0iMzIuMDE1IiB5Mj0iODkuNCIgc3R5bGU9InN0cm9rZTojMTgxODE4O3N0cm9rZS13aWR0aDowLjU7c3Ryb2tlLWRhc2hhcnJheTo1LDU7Ii8+PC9nPjwvZz48ZyBjbGFzcz0icGFydGljaXBhbnQtbGlmZWxpbmUiIGRhdGEtcXVhbGlmaWVkLW5hbWU9IkJvYiIgZGF0YS1lbnRpdHktdWlkPSJwYXJ0MiIgaWQ9InBhcnQyLWxpZmVsaW5lIiBkYXRhLXNvdXJjZS1saW5lPSIyIj48Zz48dGl0bGU+Qm9iPC90aXRsZT48cmVjdCB4PSI4My4zNTEiIHk9IjQxLjgiIHdpZHRoPSI4IiBoZWlnaHQ9IjQ3LjYiIGZpbGw9IiMwMDAiIGZpbGwtb3BhY2l0eT0iMCIvPjxsaW5lIHgxPSI4Ni44NTEiIHkxPSI0MS44IiB4Mj0iODYuODUxIiB5Mj0iODkuNCIgc3R5bGU9InN0cm9rZTojMTgxODE4O3N0cm9rZS13aWR0aDowLjU7c3Ryb2tlLWRhc2hhcnJheTo1LDU7Ii8+PC9nPjwvZz48ZyBjbGFzcz0icGFydGljaXBhbnQgcGFydGljaXBhbnQtaGVhZCIgZGF0YS1xdWFsaWZpZWQtbmFtZT0iQWxpY2UiIGRhdGEtZW50aXR5LXVpZD0icGFydDEiIGlkPSJwYXJ0MS1oZWFkIiBkYXRhLXNvdXJjZS1saW5lPSIyIj48cmVjdCB4PSIxMCIgeT0iMTAiIHdpZHRoPSI0NC4wMyIgaGVpZ2h0PSIzMC44IiBmaWxsPSIjRTJFMkYwIiBzdHlsZT0ic3Ryb2tlOiMxODE4MTg7c3Ryb2tlLXdpZHRoOjAuNTsiIHJ4PSIyLjUiIHJ5PSIyLjUiLz48dGV4dCB4PSIxNyIgeT0iMzAuNzYyIiBmaWxsPSIjMDAwIiBmb250LXNpemU9IjE0IiB0ZXh0TGVuZ3RoPSIzMC4wMyI+QWxpY2U8L3RleHQ+PC9nPjxnIGNsYXNzPSJwYXJ0aWNpcGFudCBwYXJ0aWNpcGFudC1oZWFkIiBkYXRhLXF1YWxpZmllZC1uYW1lPSJCb2IiIGRhdGEtZW50aXR5LXVpZD0icGFydDIiIGlkPSJwYXJ0Mi1oZWFkIiBkYXRhLXNvdXJjZS1saW5lPSIyIj48cmVjdCB4PSI2Ny40ODIiIHk9IjEwIiB3aWR0aD0iMzguNzM4IiBoZWlnaHQ9IjMwLjgiIGZpbGw9IiNFMkUyRjAiIHN0eWxlPSJzdHJva2U6IzE4MTgxODtzdHJva2Utd2lkdGg6MC41OyIgcng9IjIuNSIgcnk9IjIuNSIvPjx0ZXh0IHg9Ijc0LjQ4MiIgeT0iMzAuNzYyIiBmaWxsPSIjMDAwIiBmb250LXNpemU9IjE0IiB0ZXh0TGVuZ3RoPSIyNC43MzgiPkJvYjwvdGV4dD48L2c+PGcgY2xhc3M9InBhcnRpY2lwYW50IHBhcnRpY2lwYW50LXRhaWwiIGRhdGEtcXVhbGlmaWVkLW5hbWU9IkFsaWNlIiBkYXRhLWVudGl0eS11aWQ9InBhcnQxIiBpZD0icGFydDEtdGFpbCIgZGF0YS1zb3VyY2UtbGluZT0iMiI+PHJlY3QgeD0iMTAiIHk9Ijg5LjQiIHdpZHRoPSI0NC4wMyIgaGVpZ2h0PSIzMC44IiBmaWxsPSIjRTJFMkYwIiBzdHlsZT0ic3Ryb2tlOiMxODE4MTg7c3Ryb2tlLXdpZHRoOjAuNTsiIHJ4PSIyLjUiIHJ5PSIyLjUiLz48dGV4dCB4PSIxNyIgeT0iMTEwLjE2MiIgZmlsbD0iIzAwMCIgZm9udC1zaXplPSIxNCIgdGV4dExlbmd0aD0iMzAuMDMiPkFsaWNlPC90ZXh0PjwvZz48ZyBjbGFzcz0icGFydGljaXBhbnQgcGFydGljaXBhbnQtdGFpbCIgZGF0YS1xdWFsaWZpZWQtbmFtZT0iQm9iIiBkYXRhLWVudGl0eS11aWQ9InBhcnQyIiBpZD0icGFydDItdGFpbCIgZGF0YS1zb3VyY2UtbGluZT0iMiI+PHJlY3QgeD0iNjcuNDgyIiB5PSI4OS40IiB3aWR0aD0iMzguNzM4IiBoZWlnaHQ9IjMwLjgiIGZpbGw9IiNFMkUyRjAiIHN0eWxlPSJzdHJva2U6IzE4MTgxODtzdHJva2Utd2lkdGg6MC41OyIgcng9IjIuNSIgcnk9IjIuNSIvPjx0ZXh0IHg9Ijc0LjQ4MiIgeT0iMTEwLjE2MiIgZmlsbD0iIzAwMCIgZm9udC1zaXplPSIxNCIgdGV4dExlbmd0aD0iMjQuNzM4Ij5Cb2I8L3RleHQ+PC9nPjxnIGNsYXNzPSJtZXNzYWdlIiBkYXRhLWVudGl0eS0xPSJwYXJ0MSIgZGF0YS1lbnRpdHktMj0icGFydDIiIGlkPSJtc2cxIiBkYXRhLXNvdXJjZS1saW5lPSIyIj48cG9seWdvbiBwb2ludHM9Ijc0Ljg1MSw2Ny40LDg0Ljg1MSw3MS40LDc0Ljg1MSw3NS40LDc4Ljg1MSw3MS40IiBmaWxsPSIjMTgxODE4IiBzdHlsZT0ic3Ryb2tlOiMxODE4MTg7c3Ryb2tlLXdpZHRoOjE7c3Ryb2tlLWxpbmVqb2luOm1pdGVyO3N0cm9rZS1taXRlcmxpbWl0OjEwOyIvPjxsaW5lIHgxPSIzMi4wMTUiIHkxPSI3MS40IiB4Mj0iODAuODUxIiB5Mj0iNzEuNCIgc3R5bGU9InN0cm9rZTojMTgxODE4O3N0cm9rZS13aWR0aDoxOyIvPjx0ZXh0IHg9IjM5LjAxNSIgeT0iNjYuNTc5IiBmaWxsPSIjMDAwIiBmb250LXNpemU9IjEzIiB0ZXh0TGVuZ3RoPSIzMC44MzYiPkhlbGxvPC90ZXh0PjwvZz48P3BsYW50dW1sLXNyYyBTeXA5SjR2THFCTEpTQ2ZGaWJCbUlDdDlvVVRJVzA4a0JhQ3o4bUNaQ3ByQjAwMDA/PjwvZz48L3N2Zz4=" class="uml" alt="uml diagram" title="" />
   

2. Include diagrams — Reference to an external .puml file:

   <img src="data:image/svg+xml;base64,<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" style="width:540px;height:334px;background:#FFFFFF;" width="540px" height="334px" viewBox="0 0 540 334" zoomAndPan="magnify" preserveAspectRatio="none" contentStyleType="text/css"><?plantuml 1.2026.9?><defs/><g font-family="sans-serif" lengthAdjust="spacing"><rect x="0" y="0" width="539.151" height="211.601" fill="#FFF" style="stroke:#FFF;stroke-width:1;"/><text x="5" y="16.796" fill="#000" font-size="12" textLength="129.247" font-weight="700">Welcome to PlantUML!</text><text x="5" y="31.196" fill="#000" font-size="12"> </text><text x="5" y="45.596" fill="#000" font-size="12" textLength="242.21">You can start with a simple UML Diagram like:</text><text x="5" y="59.996" fill="#000" font-size="12"> </text><text x="5" y="74.396" fill="#000" font-size="12" textLength="93.169" font-family="monospace">Bob->Alice: Hello</text><text x="5" y="88.797" fill="#000" font-size="12"> </text><text x="5" y="103.197" fill="#000" font-size="12" textLength="13.644">Or</text><text x="5" y="117.597" fill="#000" font-size="12"> </text><text x="5" y="131.997" fill="#000" font-size="12" textLength="74.797" font-family="monospace">class Example</text><text x="5" y="146.397" fill="#000" font-size="12"> </text><text x="5" y="160.797" fill="#000" font-size="12" textLength="303.194">You will find more information about PlantUML syntax on</text><text x="310.834" y="160.797" fill="#000" font-size="12" textLength="113.317" text-decoration="underline">https://plantuml.com</text><text x="5" y="175.197" fill="#000" font-size="12"> </text><text x="5" y="189.597" fill="#000" font-size="12" textLength="92.233">(Details by typing</text><text x="99.873" y="189.597" fill="#000" font-size="12" textLength="36.936" font-family="monospace">license</text><text x="139.449" y="189.597" fill="#000" font-size="12" textLength="49.248">keyword)</text><text x="5" y="203.997" fill="#000" font-size="12"> </text><image width="80" height="71" x="453.151" y="6" xlink:href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAFAAAABHCAMAAACnHDC8AAADAFBMVEX///+BpbvD3u/f7vfPz8+nz+g3ksuZEDkWADr/ujlvsdpTodLCwsOLwOEbg8T//v6pqamZETnLysvT09To5+jqLS4VATj9/f27u7vDw8MTfsK+v7/j4+SOweJprdjL4/KxsbEri8jk8PgXa57c29uUETez1utQoNJ1tNtEmc9cptWBut6ayOW/3O6YEDjY6vUfhcXBwcHs7Ozw9/v83t79uTn7+/vX19ehoaHx8fG2tLXHx8fuVlfrNTYaBjn/vUH5+fmko6WXl5f/+fn95ub+9PT+8PD3qKidmaMxIUrnqDWcFj7n5eX09PTu7u2SkpKfnZ6rq6z0lJTm4tzJrHUfDT339/eFGDn6tjcrEzOvrbBuZ3l4eomSMS7Hz9Smpqasu8SFiYuQETfa2du1m6OOM051J0NWTWL5xse4uLj6zc33r6/4vb7ydHXqLi/72dntTE3tR0ijbn5jW3C+u8NANVQrG0XFubqRVGZza4GQGT2VaS7a0NPJtI6IJj/zszrfqkXXzr/Hw8cgC0LUqltOQ2JsSC5bTGjOpFafSi2+iDGtyt14m7TJhTCPJUSwoIG/qa+ikHiIgpCRHjI9j8KXbnaQH0FLf6FGPlp0cnYyKE2rg49Wj7dFXHmcwtrp6uu+xMjvYWLvW1z97e3sPD3sP0DuUlP709PYzdDPmzqZWWySRVygfHHd1smWkZ+PgnibETqsl260q5fLuppJLC/dpj2HPFLTtHv/ujrTwJy5s6iWjIi0iD3joTTCmU3trjuvZS2zlFvjq0HSyLbYp0qRts10XGxEKC9yPVBQZIOPdlNvMk2NeYNqRlujtcCVrr3j5eY1gK9Qn9GLp7lbeJXRxrCkiZDaozyukoJ+H0B3rc+OYy+iprJkYXdhmr6ee0afs79xq9BikrGKjI3FomEiLFO0ay6nfIm4pZXRjTFuhZSZWm0zcZyJN0KNTk4eebNfdIGGlZ93h5kcED5nOVYyRWbziIk9dJ4kerE5ZYxRUnLG1d7p8PTvY2PtTk/1nZ1ycV/bAAAFx0lEQVR4Xu1Ye1BUVRg/e3dhl4csKyxqPlBJQVETF2icAY13GogkEFqizqRRpoBpTCIapaUOhWNjUdOMSBpqJYZTg4KigFKADzSIVZ4qD5VFluXhLgvbPee+r49R7v2z3+zcc77fOfPb7zvfPd85uwCIhwT4wPisANwPAuIKHnbHH1I+KwAXDA18ShDW58CneCEnXl8JGwmfHylCPSvlZ/FWxh8YIRIxTWkZAEofkTz8sNq7tAqE2gODOB6GYZobVaH20SVZ4oQcdmXV0L7c4b8OFvJHRoYwdVIoyPX3gxtFDA+V8e6mM8pBoCjij4wQiWo/ALzV/kpkifBi13p4waZuGrJEECycixcEVSbYgFwUozg4/qSraOxrP7O8Eogj2HDxyMWmzpk6823+yIjhvR7fLOpDsCuGhwC0WfbkjQq8A0MWC0EgIYzPCYMymM8Iwcvz6K4IWw8skTrgq3iPMIQnxdfKrvyedpyvbSsyBQt6zcH6OxXmjqYxg9PbgXBBveK6aRAXNEl1Ssc+hz7Bgntyohb/ggQlNrrdzfIuoYKSb79067PrRoLmGo25SeghJRn1yMrSbPTptZaoBlwtlWbBHspxiW+mW8+46ereVnMXGxbFQ+mjofiHZTrclJn5E14UEgdrO9tRVph0HDJlYlRsLv4XFA7RBA1kK5ogBb7gtn08AvxWymc2b+YzLHC3nnOCNHvdayUsZpnnwnPqGf+yGKcPKlv92vtJC209zGyRWJmgyd16sSGGT/AmM2rdKZKZHxwCz7KUodLzJOO8th4OBqxdo0c2tfUkNr3QlJkZQWWMBP0uwBHvmQQb3zRVCMnsMO6ATazf3f0kkza0HTaPCdIhpyTknqP61Te1eV2gRpr1FUn4xtxRT72pDHhj09/UnBLjiv72p4d8FEtlLibBd7Qg0xK5+XfS9q2AzxSVHPnNIMBS8BQPw8N1W4glQWj0mtp4+nSHhvKYOM4GL6vH1jGTcDQ3p1979AQPI5agXEDYwuS5awknJ73rHU56RyLAr6ACpO5iMRGvp3XykjImgs4Fgm2/7URc8dhbeD9jdhYVNon0mdFcAjTIXbmC75VrmVHcQ+JDIXbuNmYUYlZoYx6XcWjKTWavYXd1WzU9OEh9wLFfEVFza5PEhVhDAvfLx60cWM3ePMa9hyZG5DNr6DbQiCUcYU0AKGzGyYxlkf+wxnCk+wdwCbA/TkWH7Dbgoq8dcmKNssQQ3F/JmMxlIj/fzo/7s9OIwUMebbYzbh2zLfk7ehBGzIau6OeO+xzGKlBRwCGAXNaCFgYbRoKG+hMTfMff4M6h0LYxpmv/92ym9tIxc4uRzawynCEWGhum7odf9/75vh8zg0bKijX5AMxhMacsK8pBxaJihtnQqr1KG8yFMzq/dutJ2iKwNCbXA7Yamsm2Xn0XtgtowY3Xy8rpYc4NNqon8eM49k+NtzU55GtMleGAkNR6oldDMhH+e9EX0JB+UYKv4WgLZrLCjHV7wnyYlzJZvYV6A6d1w6xEph842UUyTkjGIbzwRA/JIOBJKSt88yglqND1h6TpiQqQV99wmJ7nknQcgIIHqd00EwSzgudigGYQUHE4qFMcGJb22kp7lNop8p6znStvg5S2e1TVRti56w/zj8fZzKLiDa317MqBQFbs+J3dcbSgo+H4D0kLOokJ82/NR8KZbp9eIZgllwKR8Ec1ejIX827POk/06HpYffGd5dkoZJXMqDAVXd1Nbhavlx4OyuAiPcyAF3Ick8faXAuE5WToApkMxykL1PbNRJ91SDkXOyymPFR1UMlw9GjRPKCrPsRSvUnbzbkELj2PSSRkQLiH1AvROTutlpryLHQAoCD+C2BBP4npMwd9zsIgzgaDsK+bctmVw3hetai5t9RS4PEqub4QnCvxteGzOZyQXxjscxkhHisWKMi72+T0p1dxGeGYkG0ez+eeG7In/n/oNOexC9fzIiLvPxVtKp84iza+AAAAAElFTkSuQmCC"/><rect x="0" y="211.601" width="539.151" height="121.4" fill="#000" style="stroke:#000;stroke-width:1;"/><text x="5" y="228.601" fill="#33FF02" font-size="12" textLength="361.58" font-weight="700" font-style="italic">PlantUML version 1.2026.9 / 18d0aae [2026-10-17 08:25:10 UTC]</text><rect x="5" y="239.002" width="140.61" height="21.8" fill="#33FF02" style="stroke:#33FF02;stroke-width:1;"/><text x="6" y="254.002" fill="#000" font-size="14" textLength="138.61" font-weight="700">[From string (line 2) ]</text><text x="5" y="274.801" fill="#33FF02" font-size="14" font-weight="700"> </text><text x="5" y="291.601" fill="#33FF02" font-size="14" textLength="71.095" font-weight="700">@startuml</text><text x="29.64" y="308.401" fill="#33FF02" font-size="14" textLength="201.711" font-weight="700" text-decoration="wavy underline">!include path/to/diagram.puml</text><text x="8.08" y="325.201" fill="#F00" font-size="14" textLength="245.885" font-weight="700">cannot include path/to/diagram.puml</text><?plantuml-src Kr200CNClEISqfHKXOB4aWpzadpzbCp4zAB4NBs2qjmSBYv3FIC38pCzIm00?></g></svg>" class="uml" alt="uml diagram" title="" />
   

Docker Dependencies

The Dockerfile installs the following packages for PlantUML:

• openjdk17-jre — Java runtime for executing the PlantUML JAR.
• graphviz — Required for PlantUML's !include and certain diagram types.
• PlantUML JAR — Downloaded from the official GitHub releases to /opt/plantuml/plantuml.jar.

Disabling PlantUML

To disable PlantUML rendering, comment out the plantuml_markdown block in mkdocs.yml and remove the PlantUML-related packages from the Dockerfile.

PWA (Progressive Web App) Manifest

Overview

The site is installable as a Chrome Progressive Web App (PWA) that launches in a standalone window without browser chrome (address bar, tabs, etc.).

Manifest File (mkdoc/docs/manifest.json)

{
    "name": "Scanframe Wiki",
    "short_name": "Scanframe",
    "start_url": "/",
    "display": "standalone",
    "theme_color": "#1e3c72",
    "background_color": "#1e3c72",
    "icons": [
        {
            "src": "assets/icon-192.png",
            "sizes": "192x192",
            "type": "image/png"
        },
        {
            "src": "assets/icon-512.png",
            "sizes": "512x512",
            "type": "image/png",
            "purpose": "any maskable"
        }
    ]
}

• display: standalone — Removes the browser's address bar, tabs, and navigation controls.
• theme_color — Set to #1e3c72 to match the site's header gradient.
• Icons — Two sizes generated from the existing 599×599 logo: 192×192 (home screen) and 512×512 (Chrome App installation).

Template Override (mkdoc/overrides/main.html)

A template override injects the manifest link into the HTML <head>:

{% extends "base.html" %}

{% block extrahead %}
{{ super() }}
<link rel="manifest" href="{{ 'manifest.json' | url }}" crossorigin="use-credentials"/>
{% endblock %}

The custom_dir: overrides setting in mkdocs.yml tells Material for MkDocs to use this template.

Custom CSS (mkdoc/docs/stylesheets/extra.css)

Font and Spacing Adjustments

• Root font size: Reduced from Material's default 125% to 100%.
• Body text: 0.9rem with 1.5 line height (default is 1.6).
• Navigation: 0.9rem font size with 1.1 line height.
• Grid max width: Increased from 61rem to 100rem for wider content areas.

Sidebar Customization

• Width: Set to 24rem on large screens.
• Padding: Left padding removed from the sidebar inner container.
• Title wrapping: Long titles wrap instead of showing ellipsis (...).
• Chevron icons: Enlarged to 2.5em with vertical centering (align-self: center) for better visibility.

Color Overrides

• Header: Dark blue gradient from #1e3c72 to #2a5298.
• Footer meta: Reverse gradient from #2a5298 to #1e3c72.
• Light mode background: Page background set to #efefef (light gray) instead of white.
• Light mode code blocks: Code background set to #e0e0e0 to contrast with the gray page background.

Production Domain Styling (Hide Chrome)

When served from www.scanframe.com under the /website path, the following elements are hidden:

• .md-header — Site header (navigation bar).
• .md-nav--primary — Navigation sidebar content.
• .md-footer — Site footer.
• .md-sidebar--primary — Sidebar container width collapsed to 0 so main content fills the full page.

The hide-chrome class is added to <body> by hide-elements.js when both conditions are met: hostname is www.scanframe.com AND the path starts with /website.

Table Styling

• Vertical borders: Added 1px right border to all table cells using the theme's --md-default-fg-color--lightest color variable.
• Clean edges: The right border is removed from the last cell in each row so the table edge stays clean.
• Font size: Table font size reset from theme default to inherit from parent.

Custom JavaScript (mkdoc/docs/javascripts/hide-elements.js)

The script detects the current domain and path, then adds the hide-chrome class to <body> when both conditions are met:

• location.hostname is www.scanframe.com.
• location.pathname starts with /website.

The script uses Material's document$ subscription pattern (when available) to run on every SPA navigation, ensuring the class persists across page changes. On non-matching hosts or paths, the script does nothing.

CPU Optimization

Problem

The default MkDocs livereload module polls for file changes every 0.5 seconds, causing approximately 5.5% idle CPU usage even when no files are being edited.

Solution

The polling interval is patched in the Dockerfile from 0.5 seconds to 600 seconds (10 minutes):

RUN sed -i 's/polling_interval: float = 0\.5/polling_interval: float = 600/' \
    /usr/local/lib/python3.11/site-packages/mkdocs/livereload/__init__.py

This effectively stops the constant file system polling while keeping the server running. The idle CPU usage drops from 5.5% to approximately 0.05%.

Trade-off

With polling disabled, automatic live reload is no longer functional. The watch section in mkdocs.yml is commented out, and manual rebuilds via build.sh restart or event-driven watching via build.sh auto-restart are used instead.

Alternative: Event-Driven Watching

The auto-restart command in build.sh provides automatic rebuilds with near-zero CPU usage by using Linux's inotify kernel event system instead of polling. This gives the convenience of automatic rebuilds without the CPU overhead.

Icon Assets

File	Size	Purpose
assets/scanframe.png	100×100	Site logo in the header.
assets/scanframe-large.png	599×599	Source image for PWA icons.
assets/scanframe.ico	—	Browser favicon.
assets/icon-192.png	192×192	PWA home screen icon (generated from large logo).
assets/icon-512.png	512×512	PWA installation icon (generated from large logo).

Enabling and Disabling Features

To Enable File Watching

1. Uncomment the watch section in mkdoc/mkdocs.yml.
2. Rebuild the Docker image: ./build.sh build.

To Use Event-Driven Auto-Restart

1. Install inotify-tools: apt-get install inotify-tools.
2. Run ./build.sh auto-restart in the foreground.
3. Press Ctrl+C to stop watching.

To Disable PlantUML

1. Comment out the plantuml_markdown block in mkdoc/mkdocs.yml.
2. Remove the Java, Graphviz, and PlantUML JAR installation steps from mkdoc/Dockerfile.
3. Rebuild the Docker image.

To Change Colors

Edit the primary and accent values under the palette section in mkdocs.yml. See the Material for MkDocs color documentation for available colors.

To Add a Navigation Section

Edit mkdoc/docs/_navigate_.yml and add a new entry with an emoji prefix and the content directory path.

To Rename a Subdirectory in Navigation

Create a _navigate_.yml file in the target subdirectory with a title: field, for example:

title: ⚙️ Configuration

This overrides the auto-discovered directory name in the navigation sidebar.