Formatting comments

Comments on a savings recommendation take Markdown. Every syntax below works in the comment box, and the last section names the GitHub syntax that does not.

The composer has two tabs. Write is the plain-text editor, Preview renders the result.

Text styling

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.

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.

Links

Write a link as [label](url). A bare URL becomes a link on its own, 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

Multi-line code goes in a fenced block. 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 LevelFour inserts their name into your comment.

LevelFour notifies the person by email and in the app, with a link that opens the recommendation drawer at your comment. You can only mention members of your own organization.

Attaching images and files

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 embed inline. Everything else becomes a download link.

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. Tags show as text instead of rendering.
• Emoji shortcodes. :tada: stays literal. Paste the emoji character instead.
• Issue and pull request autolinks. #123 is plain text. Use a full URL.