From a3f2027270cbb0590507c718ad86cf6044bc3b28 Mon Sep 17 00:00:00 2001 From: MantisClone Date: Sat, 22 Mar 2025 00:58:08 -0400 Subject: [PATCH] chore: clarify that code blocks are not supported --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b6d47b4..843865e 100644 --- a/README.md +++ b/README.md @@ -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 `@` placeholder, which will be automatically replaced with the PR author's username.