The toolbar inserts Markdown for you. Toggle between the “Write” and “Preview” tabs to verify how your comment will render before posting.
Examples of Markdown the toolbar generates
Bold, italic and strikethrough
Note: exact shortcuts may vary by operating system and browser. The “Formatting help” link inside the comment editor lists the current shortcuts for your environment.
GitHub-specific behaviors to expect
- Mentions (
@username) and issue/PR references (#123) autocomplete and render as links when posted. - Fenced code blocks accept a language tag for syntax highlighting, for example
```javascript. - Task lists render interactive checkboxes in issue and PR conversations (they are clickable when the comment is part of the thread).
- Emoji shortcodes (e.g.,
:rocket:) convert to their emoji glyphs in the rendered comment. - The toolbar is helpful for users unfamiliar with Markdown, but composing directly in Markdown remains faster once you know the syntax.
Prefer keyboard-only editing? Learn a few Markdown basics and the keyboard shortcuts to compose rich comments faster than relying purely on mouse clicks. See the Markdown help and keyboard shortcuts.
- GitHub: Basic writing and formatting syntax
- GitHub: Keyboard shortcuts
- GitHub: Working with mentions and references