Guides

Formatting Comments

Comments on a savings recommendation are written in Markdown. This page lists every syntax the comment box understands, and what each one produces.

The composer has two tabs. Write is the plain-text editor, Preview renders the result. Anything shown in Preview is what other people will see once you post.

Text styling

You typeYou get
**bold**bold
_italic_italic
~~struck through~~struck through
`inline code`inline code
**bold and _nested italic_**bold and nested italic

Headings

Start a line with one to six # characters, followed by a space.

# Largest heading
## Second level
### Third level

The toolbar's H button inserts a # at the start of the current line. Press it and the line becomes a heading.

Line breaks and paragraphs

A single newline breaks the line. A blank line starts a new paragraph.

First line.
Second line, directly below the first.

A new paragraph.

Lists

- Unordered item
- Another item
  - Indent two spaces to nest

1. Ordered item
2. Second item

Task lists render as checkboxes:

- [ ] Not done yet
- [x] Done

Checkboxes in a posted comment are read-only. Edit the comment to tick one.

Write a link as [label](url). A bare URL is linked automatically, so https://levelfour.ai needs no markup.

Links open in a new tab.

Quotes

Prefix a line with >:

> Finance signed off on this in the Q3 review.

Code

Wrap a phrase in single backticks for inline code. For anything multi-line, use a fenced block and name the language after the opening fence:

```bash
aws ec2 describe-volumes --filters Name=status,Values=available
```

Fenced blocks keep their whitespace and scroll sideways instead of wrapping, so command output and log excerpts stay readable.

Tables

Separate cells with | and put a row of dashes under the header. A colon in the dash row sets the column alignment.

| Account | Before/mo | Saved/mo |
|---|---:|---:|
| Production | $641.10 | $209.09 |
| Staging | $318.00 | $209.67 |

Leave a blank line before the table. A wide table scrolls sideways within the comment rather than stretching it.

Horizontal rule

Three dashes on their own line draw a divider:

---

Mentioning a teammate

Type @ followed by part of a name or email address. Pick someone from the list that appears, and their name is inserted into your comment.

Mentioned people are notified by email and in the app, with a link that opens the drawer at your comment. You can only mention members of your own organization.

Editing a mention removes it. If you delete part of the name, the whole mention goes with it, so a comment never carries a half-broken reference.

Attaching images and files

Three ways to attach:

  • Paste. Copy a screenshot and paste it into the comment box.
  • Drag and drop. Drop the file onto the box.
  • Click. Use the paperclip in the toolbar.

Images are embedded inline. Everything else is inserted as a download link. Attachments are private to your organization: they are stored in LevelFour's own bucket and served only to signed-in members of your workspace.

LimitValue
Maximum size10 MB per file
Image formatsPNG, JPEG, GIF, WebP
Other formatsPDF

Attaching a file inserts the Markdown for you. Move the cursor first if you want the attachment somewhere other than where you left off.

Not supported

A few things GitHub does that LevelFour comments do not:

  • Raw HTML. HTML tags are shown as text, not rendered.
  • Emoji shortcodes. :tada: stays literal. Paste the emoji character instead.
  • Issue and pull request autolinks. #123 is plain text. Use a full URL.
Comments are visible to everyone in your organization who can open the recommendation. Reactions and the Seen by row are visible too.