Blog post "YAML best practices": Whitespaces after colon `:` and before hashtag `#` are not rendered
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 72/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- yaml
- Domain
- documentation
Research direction
Start with blog/2025-07-20.md at the plain scalars section linked in the issue, then compare its generated rendering at the blog URL. Update the example or surrounding explanation so whitespace after : and before # is visible and the clarification is included; verify the rendered post matches the source.
Written by the indexing model from the issue text.
Description
Problem
The blog post about YAML best practices where it covers plain scalars does not render the whitespace after colon : and before hashtag #.
- Rendered blog post: https://yamlscript.org/blog/2025-07-20/yaml-best-practices/#dont-quote-strings-that-dont-need-to-be-quoted
- Source: https://github.com/yaml/yamlscript/blob/v0/blog/2025-07-20.md#dont-quote-strings-that-dont-need-to-be-quoted
That makes it look like plain scalars cannot contain : and # at all, which is wrong.
Solution
- (If possible) make the whitespaces render in the blog post.
- (Also) specify that whitespace after colon
:and before hashtag#: A whitespace without that info can be misinterpreted.
- Dominant language
- Clojure
- Stars
- 644
- Forks
- 62
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from yaml/yamlscript
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
yaml/yamlscript#273 ·
-
Difficulty 5/5 Over a week Newbie friendliness 30/100
yaml/yamlscript#272 ·
-
Difficulty 5/5 Over a week Newbie friendliness 8/100
yaml/yamlscript#265 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 48/100
yaml/yamlscript#264 · 1 comment ·
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
yaml/yamlscript#217 ·
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
-
.Team/Metabot Priority:P3
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
needs triage
Difficulty 1/5 Under an hour Newbie friendliness 90/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
scalar-labs/scalar-jepsen#222 · 1 comment ·