Repository navigation
Keep the frontmatter when formatting the docs - #235
Merged
Merged
Conversation
|
Hello 👋 Here are the most recent benchmark results, compared against StackHydrator
StackHydratorWithLazy
StackHydratorWithCryptography
This comment gets updated every time a new commit comes in. |
The docs scripts parse the pages with CommonMark, which rendered the frontmatter as a thematic break and a heading. They use the FrontMatterExtension now, the same way as the scripts of the event-sourcing repository.
DavidBadura
force-pushed
the
keep-docs-frontmatter
branch
from
October 18, 2026 17:40
e99e54d to
f73f4ec
Compare
Merged
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
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.
make docsparses every page with CommonMark and renders it again. Without front matter support---became a thematic break andsearchable: falsetogether with the closing---a heading. Both docs scripts now register theFrontMatterExtensionof league/commonmark with a parser which keeps the raw YAML, so the front matter is written back byte for byte. The scripts are the same as in the event-sourcing repository now, the extension is part of league/commonmark, no new dependency is needed.None of the pages on 2.1.x has front matter yet, but the upgrade guide on 3.0.x has, and every
make docsbroke it there.