Keep spotless away from the site sources - #436
Open
slachiewicz wants to merge 1 commit into
Open
Conversation
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The markdown formatter runs flexmark over every
*.mdin the tree, including the Doxia sources undersrc/site/markdown. Those pages open with a YAML front matter block carrying the page title, author and date: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:checkpasses, 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.