fix(docs): quote summary values containing colons in front matter - #123
Merged
Merged
Conversation
GitHub's YAML front-matter renderer rejected every doc whose summary
value contained a colon-space ("mapping values are not allowed in this
context"). Quote the 21 affected summary values so all doc front
matter parses as valid YAML.
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.
Problem
Viewing any affected doc on GitHub showed:
The
summary:front-matter values contained an unquoted colon-space(e.g.
Oliver's feature matrix: implemented, ...), which YAML parses as anested mapping indicator. The
published_attimestamps were fine.Fix
Double-quote the
summaryvalue in all 21 affected docs (values containapostrophes, so double quotes avoid single-quote escaping).
Verification
.mdin the repo as a mappingwith the expected keys, including duplicate-key detection.
.yml/.yamland.jsonfiles: all valid.tests/fixtures/markdown/frontmatter-unclosed.mdis intentionallyunterminated (parser fixture) and was left alone.