Skip to content

Fix generated documentation rendering - #52

Merged
TristanKruse merged 1 commit into
mainfrom
docs/fix-markdown-rendering
Oct 16, 2026
Merged

TristanKruse merged 1 commit into
mainfrom
docs/fix-markdown-rendering

Conversation

@LukasNiessen

Copy link
Copy Markdown
Owner

Summary

  • use Kramdown-compatible fenced code blocks throughout the README
  • prevent literal fence markers and wildcard emphasis from leaking into generated docs

Verification

  • bundle exec rake docs (169 pages and internal links validated)
  • bundle exec rake (455 examples, 0 failures; RuboCop 235 files, no offenses)

@TristanKruse TristanKruse left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed the README fence conversion. The guide renders 26 code blocks with syntax highlighting and no literal fence markers. Existing CI passes; code examples are preserved.

@TristanKruse
TristanKruse merged commit cc98a60 into main Oct 16, 2026
10 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