ditkrg/todo-to-issue-action
4
0
Fork 0
mirror of https://github.com/ditkrg/todo-to-issue-action.git synced 2026-01-22 22:06:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Alastair Mooney 2025-04-02 14:56:05 +01:00 committed by GitHub
parent 0672dc170b
commit c077cbe999
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -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.