Correctly detect frontmatter to avoid mangling document (fixes #180, fixes #189) #190
Conversation
This file contains 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
gregdan3
changed the title
The previous format would incorrectly capture: - A single horizontal rule at the top of the file - Three literal dashes with arbitrary content after them. This was detected as a frontmatter, and an extra HR would be inserted after as a result. The new format requires that there are two sets of triple dashes on their own lines, where the first is the first text in the document.
This was referenced Sep 17, 2023
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.
The previous format would incorrectly capture:
The new format requires that there are two sets of triple dashes on their own lines, where the first is the first text in the document. This is necessarily the bounding box of a frontmatter, though the inner yml could be invalid and then would appear in the document instead.
There are still two more newline related issues I've noticed:
If the TOC is first or last item in the document, two spare newlines will be added on the contentless side every generation. Presumably caused by the section being empty but still in the section list.Went ahead and fixed this too!