Skip to content

Keep spotless away from the site sources - #436

Merged
slachiewicz merged 1 commit into
codehaus-plexus:masterfrom
slachiewicz:spotless-skip-site-markdown
Aug 8, 2026
Merged

Keep spotless away from the site sources#436
slachiewicz merged 1 commit into
codehaus-plexus:masterfrom
slachiewicz:spotless-skip-site-markdown

Conversation

@slachiewicz

Copy link
Copy Markdown
Member

The markdown formatter runs flexmark over every *.md in the tree, including the Doxia sources under src/site/markdown. Those pages open with a YAML front matter block carrying the page title, author and date:

---
title: Location Tracking
author: 
  - Benjamin Bentmann
date: 2010-04-18
---

flexmark reformats that: it inserts a blank line after the opening fence, de-indents the author list, and rewrites the closing --- as a longer run of dashes. The block is then no longer front matter, so the page loses its <meta name="author"> and takes its <title> from the first heading instead of the document title.

This came up while restoring metadata that was dropped when the Maven and Plexus site pages were converted from APT to Markdown — the converted pages cannot keep their metadata in a project that inherits this configuration.

Verified against modello with the parent installed locally: spotless:check passes, and the built site regains its author meta tags and the correct page title.

The excludes list also nested <excludes> inside itself where a single <exclude> was meant.

The markdown formatter runs flexmark over every *.md in the tree, including the
Doxia sources under src/site/markdown. Those pages open with a YAML front matter
block carrying the page title, author and date, and flexmark rewrites the fence
that closes it, so the metadata is lost and the page falls back to its first
heading for a title.

The excludes list also nested <excludes> inside itself where a single <exclude>
was meant.
@slachiewicz slachiewicz added the maintenance Cleanup, refactoring or other internal change label Aug 7, 2026
@slachiewicz
slachiewicz merged commit 65941e1 into codehaus-plexus:master Aug 8, 2026
11 checks passed
@slachiewicz
slachiewicz deleted the spotless-skip-site-markdown branch August 8, 2026 17:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

maintenance Cleanup, refactoring or other internal change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant