From c077cbe99999e836ce8ee0c377665cb00173b55e Mon Sep 17 00:00:00 2001 From: Alastair Mooney Date: Wed, 2 Apr 2025 14:56:05 +0100 Subject: [PATCH] Update README.md --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index a54bcde..3fe5c82 100644 --- a/README.md +++ b/README.md @@ -492,6 +492,10 @@ Issues are created whenever the action runs and finds a newly added TODO in the Enabling [URL Insertion](#url-insertion) can help with the detection of existing issues. +### Formatting issues with nested code blocks in Markdown files + +When creating an issue, the action wraps code blocks in backticks. If the code block itself is a Markdown file containing backticks, this may result in formatting issues. For simplicity, it is recommended to manually edit these issues if needed. One way to resolve this is by using `~` as an alternative delimiter for nested code blocks. + ## Contributing & Issues If encounter any problems, please file an issue or submit a PR. Everyone is welcome and encouraged to contribute.