Skip to content

Preserve Markdown frontmatter and check documentation sources - #205

Merged
timkpaine merged 1 commit into
mainfrom
docs/frontmatter-formatting
Oct 6, 2026
Merged

timkpaine merged 1 commit into
mainfrom
docs/frontmatter-formatting

Conversation

@timkpaine

Copy link
Copy Markdown
Member

Preserve YAML frontmatter when formatting Markdown in all eight Python template variants by adding mdformat-frontmatter to the generated develop extra. This keeps MyST page configuration, such as heading_anchors, from being rewritten as Markdown headings.

Include existing docs/src directories in both formatting and spelling targets alongside README and optional wiki content. Use Make’s wildcard expansion so projects without that directory continue to lint and format successfully. Preserve Cython’s existing docs/development.md checks.

Generated all eight variants with docs/wiki enabled and disabled: 16 projects pass documentation checks with an absent source directory and a formatted frontmatter page. Deliberately malformed Markdown and misspellings fail lint, and fix-docs repairs them while preserving the YAML header. The generated pure-Python project also passes develop, lint, distribution-content checks, tests, and build.

Signed-off-by: Tim Paine <3105306+timkpaine@users.noreply.github.com>
@timkpaine
timkpaine merged commit f6a9056 into main Oct 6, 2026
21 checks passed
@timkpaine
timkpaine deleted the docs/frontmatter-formatting branch October 6, 2026 23:44
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.

1 participant