Skip to content

Update mkdocs-material to 9.7.1 and fix deprecated configurations#295

Merged
csharpfritz merged 5 commits intodevfrom
copilot/update-docs-build-process
Jan 29, 2026
Merged

Update mkdocs-material to 9.7.1 and fix deprecated configurations#295
csharpfritz merged 5 commits intodevfrom
copilot/update-docs-build-process

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Jan 29, 2026

The docs build process was using mkdocs-material 5.5.0 (from 2020) with several deprecated configurations that would fail with newer versions.

Changes

Dockerfile (docs/Dockerfile)

  • Updated base image: squidfunk/mkdocs-material:5.5.09.7.1
  • Added mkdocs-git-revision-date-localized-plugin dependency
  • Removed unnecessary build dependencies (gcc, musl-dev)

Configuration (mkdocs.yml)

  • Emoji: materialx.emoji.twemojimaterial.extensions.emoji.twemoji
  • Syntax highlighting: codehilitepymdownx.highlight + pymdownx.inlinehilite
  • Tabs: Added alternate_style: true to pymdownx.tabbed
  • Removed deprecated theme options: include_search_page, search_index_only
  • Removed deprecated search option: prebuild_index: python

Documentation (CONTRIBUTING.md)

  • Added build instructions with Docker commands:
    docker build -t mkdocs -f ./docs/Dockerfile ./
    docker run --rm -v "$(pwd):/docs" mkdocs build --strict
    docker run --rm -p 8000:8000 -v "$(pwd):/docs" mkdocs serve --dev-addr 0.0.0.0:8000
Original prompt

This section details on the original issue you should resolve

<issue_title>Update the docs build process</issue_title>
<issue_description>We should update the docs build process which includes the docker file in the docs folder so that it's using current versions of the mkdocs tools</issue_description>

Comments on the Issue (you are @copilot in this section)


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 4 commits January 29, 2026 16:07
…ix deprecated configurations

Co-authored-by: csharpfritz <78577+csharpfritz@users.noreply.github.com>
Co-authored-by: csharpfritz <78577+csharpfritz@users.noreply.github.com>
Co-authored-by: csharpfritz <78577+csharpfritz@users.noreply.github.com>
…x compatibility

Co-authored-by: csharpfritz <78577+csharpfritz@users.noreply.github.com>
Copilot AI changed the title [WIP] Update docs build process for mkdocs tools Update mkdocs-material to 9.7.1 and fix deprecated configurations Jan 29, 2026
Copilot AI requested a review from csharpfritz January 29, 2026 16:14
@csharpfritz csharpfritz marked this pull request as ready for review January 29, 2026 16:22
@csharpfritz csharpfritz merged commit 8688ed2 into dev Jan 29, 2026
2 checks passed
csharpfritz added a commit that referenced this pull request Jan 29, 2026
Co-authored-by: csharpfritz <78577+csharpfritz@users.noreply.github.com>
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
csharpfritz added a commit that referenced this pull request Jan 29, 2026
Co-authored-by: csharpfritz <78577+csharpfritz@users.noreply.github.com>
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>
fix deprecated configurations (#295)
Fixed dockerfile for sample website (#298)
@csharpfritz csharpfritz deleted the copilot/update-docs-build-process branch March 7, 2026 16:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update the docs build process

2 participants