Search
K
Links

Rich text editor

Overview

You can add a description to a topic using Flat's rich text editor. The same editor is also used for discussion comments.
A topic's description is where you can optionally capture important context that people working on the topic will need, things like:
  • An overview of what needs to be done
  • Why the work is being done in the first place
  • Links to resources in other systems

Step-by-step

Formatting

Keyboard shortcuts

The editor recognizes all of the common formatting keyboard shortcuts you'd expect:
  • Ctrl/Cmd B to toggle bold
  • Ctrl/Cmd I to toggle italics
  • Ctrl/Cmd Shift X to toggle strikethrough
  • Ctrl/Cmd E to toggle monospace text / code
  • Tab while in a list item to indent, and Shift Tab while in a list item to dedent
  • Ctrl/Cmd K to insert a link or make selected text a link
  • Ctrl/Cmd Z to undo and Ctrl/Cmd Shift Z to redo

Markdown

The editor recognizes basic Markdown syntax formatting:
  • **text** for bold text
  • *text* or _text_ for italic text
  • ~text~ or ~~text~~ for strikethrough text
  • `text` for monospace text / code
  • # , ## , ### , #### , ##### , or ###### at the beginning of a line for headings at different levels
  • > at the beginning of a line for a block quote
  • - or * at the beginning of a line for a bulleted list
  • 1. at the beginning of a line for a numbered list
  • --- at the beginning of a line for a horizontal divider
  • ``` at the beginning of a line, then Enter, for a code block

Adding emoji

You can insert emojis by typing : followed by the emoji's name or alias, such as :+1: or :thumbsup: for
👍
. Or type : and a portion of the emoji's name, then select the emoji you want from the dropdown picker.

Inserting images

To add an image, click the image icon in the toolbar or just drag and drop an image from your computer into the editor area.

Referencing other topics

You can reference another topic by typing # followed by the topic's ID. Or type # and a portion of the topic's ID, title, labels, etc., then select the topic from the dropdown picker.