Skip to content

fix(docs): escape Liquid delimiters in rebemer.md code block - #213

Merged
jackgranatowski merged 1 commit into
mainfrom
fix/jekyll-liquid-rebemer-docs
Jun 4, 2026
Merged

fix(docs): escape Liquid delimiters in rebemer.md code block#213
jackgranatowski merged 1 commit into
mainfrom
fix/jekyll-liquid-rebemer-docs

Conversation

@jackgranatowski

@jackgranatowski jackgranatowski commented Jun 3, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Fixes the red cross on main — GitHub Pages build was failing with a Liquid syntax error
  • docs/rebemer.md line 420 contains {{from:'element-settings', keys:string[]} in a JSDoc typedef; Jekyll treats {{ as a Liquid variable delimiter even inside fenced code blocks
  • Wraps the §9 plan-model code block in {% raw %}...{% endraw %} so Liquid skips it entirely

Test plan

  • GitHub Pages build passes (green check on main after merge)
  • docs/rebemer.md §9 code block renders correctly in the Pages site

Generated by Claude Code

Summary by CodeRabbit

  • Documentation
    • Fixed documentation rendering to properly display code examples containing special characters and markup syntax.

Jekyll parses `{{` as a Liquid variable even inside fenced code blocks.
Wrapping the §9 plan-model code block in raw/endraw tags prevents the
build error on GitHub Pages.

https://claude.ai/code/session_016aL3vh5nHHa2QbmAxyFCGy
@coderabbitai

coderabbitai Bot commented Jun 3, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 6c8fcea1-6dec-483d-91c8-6f1b32651367

📥 Commits

Reviewing files that changed from the base of the PR and between 422603a and 0e0f32f.

📒 Files selected for processing (1)
  • docs/rebemer.md

📝 Walkthrough

Walkthrough

This PR adds Jekyll/Liquid templating protection to a code block in the documentation. Two lines are inserted: {% raw %} at line 400 before typedef documentation and {% endraw %} at line 450 after it, preventing the templating engine from interpreting braces and markup inside that region.

Changes

Jekyll/Liquid Template Protection

Layer / File(s) Summary
Protect typedef block from Liquid processing
docs/rebemer.md
Opening {% raw %} and closing {% endraw %} markers wrap the Plan, Operation, and ClassUpsert typedef documentation to prevent Liquid/Jekyll from interpreting braces and template syntax in the code examples.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

  • codeslash-dev/SLASHED#160: Both PRs address Jekyll/Liquid interpreting {{ ... }} in docs/rebemer.md; this PR uses local {% raw %}...{% endraw %} wrapping while the prior PR disabled Liquid rendering globally via _config.yml.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and specifically describes the main change: fixing Jekyll/Liquid delimiter escaping in the rebemer.md code block to resolve a GitHub Pages build failure.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/jekyll-liquid-rebemer-docs

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@jackgranatowski

Copy link
Copy Markdown
Contributor Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Jun 4, 2026

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@jackgranatowski
jackgranatowski merged commit 117dfdf into main Jun 4, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants