Formatting the text in the body

[AshNaz87]

Hey folks! Awesome project you have here!

Just have a question regarding the body property when creating a comment.

Is it possible to format it? I.e. make it bold or apply some colour to the text?

This may be in the documentation, but I have not come across it.

Many thanks!

[josh-]

You can use Markdown formatting in the body:

github.rest.issues.createComment({
  issue_number: context.issue.number,
  owner: context.repo.owner,
  repo: context.repo.repo,
  body: "**Bold text here**"
})

Note that if you have a multi-line comment that the indentation must be correct, otherwise your formatted text will be placed
inside an intended code block. Example of correct indentation is:

github.rest.issues.createComment({
  issue_number: context.issue.number,
  owner: context.repo.owner,
  repo: context.repo.repo,
  body: `# Images

    # Title 
    ![](https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png)`
})

[AshNaz87]

Cheers @josh-

I'll give this a spin. This really ought to be in the documentation

[AshNaz87]

Works like a charm! Cheers :)

[josh-]

You're welcome! Just opened #252 adding an example to the docs 👍

[kirillgroshkov]

Note that if you have a multi-line comment that the indentation must be correct, otherwise your formatted text will be placed
inside an intended code block.

Indeed, my issue was a wrong indentation 👍

[amol-patel]

@josh- We denote code or a command within a sentence using single backticks. Could you please explain how to escape backticks when they're part of the text body?

[joshmgross]

@amol-patel you should be able to use a \ to escape any backticks:

To escape a backtick in a template literal, put a backslash (\) before the backtick.
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals

[amol-patel]

Thank you so much @joshmgross