Add code highlighting docs

[gabber235]

Summary

• explain how line highlighting works for docs authors

Testing

• npm ci
• npm run test (fails: cannot finish build)

---

https://chatgpt.com/codex/tasks/task_e_6846ac577f4883228a901e76636a57d7

Summary by CodeRabbit

• Documentation
  • Updated the documentation to explain how to use code highlighting in code blocks, including support for colored highlight variants.

[coderabbitai]

Walkthrough

The AGENTS.md documentation was updated to add a new "Code Highlighting" section. This section describes how to use Prism magic comments for line highlighting in code blocks, including support for colored highlight variants linked to custom CSS classes.

Changes

File(s)	Change Summary
documentation/AGENTS.md	Added a section on code highlighting, explaining Prism magic comments and colored highlight options.

Possibly related PRs

• Improve AGENTS docs #344: Updates and improves AGENTS.md files with general project structure and contribution guidelines, relating to the same documentation file.

Poem

In AGENTS.md, a new light shines bright,
With magic comments guiding code in sight.
Red, green, and blue lines now glow,
Thanks to Prism’s highlighting show.
Rabbits hop through docs, so neat—
With colored lines, our code’s complete!
🐇✨

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

documentation/AGENTS.md (1)

52-59: Enhance Code Highlighting docs with concrete examples

Great addition—consider appending a live example to illustrate the magic comments and colored variants. E.g., just after line 59, add:

+## Example usage
+
+```md
+// highlight-next-line
+const importantValue = computeImportantValue();
+
+// highlight-start-green
+function processData() {
+  // processing logic
+}
// highlight-end-green
+```

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7f792a4 and fbb4f25.

📒 Files selected for processing (1)

• documentation/AGENTS.md (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: Test Documentation Build
• GitHub Check: build

[Marten-Mrfc]

Good!