Skip to content

chore: clarify that code blocks are not supported #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 22, 2025
Merged

chore: clarify that code blocks are not supported #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,15 +164,18 @@ first_pr_comment: |

## Comment Formatting

You can use full Markdown syntax in your comment messages, including:
You can use most Markdown syntax in your comment messages, including:

- Headings (`# Heading`)
- Lists (`- Item`)
- Formatting (**bold**, *italic*)
- Links (`[text](url)`)
- Code blocks
- Images
- Tables
- Emojis (`:tada:`)

> **Note:** Triple backtick code blocks are not supported due to technical limitations with the GitHub Actions script environment. If you need to include code examples, consider using inline code with single backticks or HTML alternatives.

## Special Placeholders

The first PR comment supports the `@<username>` placeholder, which will be automatically replaced with the PR author's username.
Expand Down