build: escape handlebars in step source README.md copies#287
Merged
Conversation
The previous fix wrapped {{ ... }} / {% ... %} placeholders in fenced
code blocks and inline code spans only when generating the HTML pages
under dist/<tutorial>/build/<step>/README.md. The downloadable step
sources copied to dist/<tutorial>/steps/<step>/README.md were left
untouched and went through Jekyll/Liquid as-is, so placeholders such
as {{appTitle}} and {{appDescription}} were stripped on the published
site.
Run the README files copied alongside the step sources through
escapeCodeBlocks() as well so both rendering paths preserve the
handlebars placeholders verbatim.
jnsttl
approved these changes
Jun 1, 2026
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
2 participants
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.
Why
The earlier fix in #284 wrapped
{{ ... }}/{% ... %}placeholders in fenced code blocks and inline code spans, but only when producing the rendered HTML pages underdist/<tutorial>/build/<step>/README.md.The README files copied alongside the step source code under
dist/<tutorial>/steps/<step>/README.mdwere left untouched and still went through Jekyll/Liquid as-is — so placeholders like{{appTitle}}and{{appDescription}}were stripped on the published site for that copy as well.What
Run the README files copied next to step sources through
escapeCodeBlocks()so both rendering paths preserve the handlebars placeholders verbatim.