Skip to main content

Format text in Tasks and Comments

R
Written by Rhys

Overview

You can format task descriptions and comments in BugHerd. Instead of plain text, you can add headings, lists, links, code, and more.

This is useful when feedback needs structure: steps to reproduce, a checklist, or a link back to a design.

Note: Click the image above to view a brief demonstration.


What you can format

In a task description or comment, you can:

  • Make text bold, italic, underlined, struck through, or highlighted

  • Add headings (four sizes), or set the line back to a normal paragraph

  • Add a bullet list, a numbered list, or a checklist

  • Add a link

  • Add inline code, or a code block. In a code block you can choose a language, such as JavaScript, Python, and many more.

  • Add a quote

  • Switch to Markdown source and edit the underlying text

Use the toolbar on the field. Select some text and a smaller menu appears for bold, italic, underline, strikethrough, link, and inline code.

You can paste Markdown, and the toolbar tooltips show the keyboard shortcuts. On the create-task form, the toolbar also includes emoji.

Type / for the same formatting commands. / can also run BugHerd actions such as assign, severity, and status. Those depend on where you are typing, and they are covered in Use the / command menu.


Where you can format

Formatting is available when you:

  • Create a task, from the sidebar or the project board

  • Edit the description on an existing task, from the sidebar, the project board, or My Tasks

  • Write or edit a comment, in those same places

On create task, the description field opens with the toolbar. Add headings, lists, links, or code from the toolbar, or type /. Fill out the rest of the task and submit as usual.

The same formatting is available later, when you update that description or add a comment.
​


Edit as Markdown

The toolbar includes Edit as Markdown. That shows the formatted text as Markdown (**bold**, ++underline++, lists, and so on) instead of the visual editor. Switch back the same way when you want the formatted view.
​

The shortcut is Ctrl+Alt+Shift+M on Windows, or Cmd+Alt+Shift+M on Mac.


Connected tools

If your project sends tasks or comments to another tool, BugHerd sends the text you wrote, converted into the format that tool accepts.

What to expect:

  • GitHub and Linear keep headings, lists, links, bold, italic, strikethrough, code, quotes, and checklists. Underline and highlight usually do not, because those tools have no matching style.

  • Jira receives BugHerd’s formatting in Jira’s own document format, including headings, lists, checklists, code, quotes, links, and the inline styles.

  • Asana keeps bold, italic, underline, strikethrough, lists, links, quotes, and code. Headings are simplified, highlight is dropped, and a checklist becomes a list with checkbox characters.

  • Mentions arrive as names.

  • Comments that come back into BugHerd keep basic formatting.

  • Titles in the other tool stay plain text. A GitHub issue title will not show bold.

  • Reporter, screenshot, browser details, and the BugHerd link on the remote task stay as they are.

Did this answer your question?