Preserve setext headings with colon titles by ishaanlabs-gg · Pull Request #4157 · mkdocs/mkdocs

ishaanlabs-gg · 2026-07-01T01:53:20Z

Summary

preserve colon-containing setext headings like Foo: Bar instead of treating them as MultiMarkdown metadata
add regression coverage for the metadata parser behavior

Fixes #4079.

PYTHONPATH=/Volumes/STOREJET/Documents/OSC/repos/mkdocs-list-rendering /Volumes/STOREJET/Documents/OSC/repos/mkdocs/.venv-codex/bin/python -m unittest mkdocs.tests.utils.utils_tests.UtilsTests.test_mm_meta_data_ignores_setext_heading mkdocs.tests.utils.utils_tests.UtilsTests.test_mm_meta_data mkdocs.tests.utils.utils_tests.UtilsTests.test_mm_meta_data_blank_first_line mkdocs.tests.utils.utils_tests.UtilsTests.test_yaml_meta_data mkdocs.tests.utils.utils_tests.UtilsTests.test_no_meta_data
PYTHONPATH=/Volumes/STOREJET/Documents/OSC/repos/mkdocs-list-rendering /Volumes/STOREJET/Documents/OSC/repos/mkdocs/.venv-codex/bin/python -m unittest mkdocs.tests.utils.utils_tests
PYTHONPATH=/Volumes/STOREJET/Documents/OSC/repos/mkdocs-list-rendering /Volumes/STOREJET/Documents/OSC/repos/mkdocs/.venv-codex/bin/python -m compileall -q mkdocs/utils/meta.py mkdocs/tests/utils/utils_tests.py

ishaanlabs-gg · 2026-07-01T01:59:01Z

CI note after the first run:

The CPython 3.10/3.11/3.12 failures are in BuildTests.test_draft_docs_with_comments_from_user_guide, not in the metadata parser tests touched here. The failure is the same draft-docs/pathspec issue covered separately in Dedent configured pathspec patterns #4155.
The PyPy Ubuntu failure happens before MkDocs tests run while installing dependencies: cryptography builds against PyO3 and reports that PyPy 3.9 is below PyO3's minimum supported version.

The local verification for this branch remains focused on the touched metadata behavior:

mkdocs.tests.utils.utils_tests.UtilsTests.test_mm_meta_data_ignores_setext_heading
full mkdocs.tests.utils.utils_tests
compileall and git diff --check

Preserve setext headings with colon titles

cc53a3d