The formatting shortcuts on this page apply to issue descriptions. Comments and issue type template descriptions use text areas instead, but they can still upload and display markdown images.
How formatting works
There’s no toolbar with bold/italic/heading buttons — formatting happens through markdown shortcuts as you type, the same way it would in a markdown file:
The editor also supports tables, though there’s no button or shortcut currently exposed to insert one from scratch.
Editing and viewing
Click a description to edit it; click away (or otherwise commit the change) to save it and return to a read-only view. The same editor renders both states — there’s no separate “preview” component — so what you see while editing is what other people will see once you’re done.Add images to an issue description
Paste one or more image files into a description, or drag them onto the description from your computer. Dropping onto a read-only description starts editing automatically and inserts the image near the drop position. Orbit uploads each file and inserts it into the description. An Uploading image… message remains visible while an upload is in progress, and the editor waits for pending uploads before closing. If you paste several images, Orbit keeps their order and continues with the remaining files if one fails. When you are not editing, select a rendered image to open the full file in a new browser tab.Images in comments and templates
The new-comment form and the inline editor for an existing comment accept pasted or dropped image files. Orbit inserts a markdown image at the current caret. Rendered comment images can be selected to open the full file in a new tab. Under Settings → Workspace → Issue types → Manage templates, the template description also accepts pasted or dropped images. The text area shows the markdown reference. When the template is applied to a new issue, the issue renders the image in its description. Orbit applies the first template for the selected issue type automatically when creation does not provide another template. See Issue types for the complete default behavior.File and access requirements
Uploaded files must be JPEG, PNG, GIF, or WebP images no larger than 5 MB. Orbit checks every image with its configured safety service before accepting it. The upload is rejected when:- The file type or size is invalid
- The image fails the safety check
- The safety service is unavailable
- Your project role does not allow you to create or update the content that would use the image