Skip to content

Conversation

@kagol
Copy link
Member

@kagol kagol commented Jan 22, 2026

PR

PR Checklist

Please check if your PR fulfills the following requirements:

  • The commit message follows our Commit Message Guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

  • Documentation
    • Clarified code block highlighting requirements and configuration for the highlight.js plugin integration.
    • Updated demo showing proper highlight.js implementation for code syntax highlighting.

✏️ Tip: You can customize this high-level summary in your review settings.

@github-actions github-actions bot added the bug Something isn't working label Jan 22, 2026
@kagol kagol merged commit 184542d into dev Jan 22, 2026
1 check passed
@coderabbitai
Copy link

coderabbitai bot commented Jan 22, 2026

Caution

Review failed

The pull request is closed.

Walkthrough

A Vue demo file updates its syntax configuration to use an explicit hljs instance instead of a boolean flag, while accompanying documentation consolidates guidance on code block highlighting using highlight.js into a single, unified statement.

Changes

Cohort / File(s) Summary
Highlight.js Configuration Updates
packages/docs/fluent-editor/demos/custom-toolbar.vue
Changes editor syntax flag from true to { hljs } to explicitly pass the hljs instance for code highlighting
Documentation Consolidation
packages/docs/fluent-editor/docs/demo/code-block-highlight.md
Merges multiple descriptive lines into a single statement clarifying that code block highlighting requires the highlight.js plugin passed to the syntax module's hljs option

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 With hljs now explicit and clear,
Configuration blooms throughout the year,
Docs distilled to essence pure—
Highlight syntax, bright and sure! ✨

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch kagol/fix-syntax-error

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants