Markdown and formatting

Card descriptions, comments, and notes all use GitHub-flavored markdown. This page shows each feature as the source you write, followed by how it renders.

Text styling

Use asterisks and backticks for inline emphasis, and square brackets with a URL for links.

**Bold**, *italic*, ~~strikethrough~~, and `inline code`.
Link: [Projavo](https://projavo.com)

Bold, italic, strikethrough, and inline code.
Link: Projavo

External links open in a new tab. Links that start with / stay in the same tab.

Single line breaks render as line breaks, so you don't need two trailing spaces. Bare URLs such as https://projavo.com become links automatically.

Headings

Use one to six # characters. Headings with ## and ### also appear in the "On this page" outline on docs pages.

## Section
### Subsection

Lists

Unordered lists use -, ordered lists use numbers, and both can nest.

- Design the board
  - Assign a priority
  - Add labels
- Break work into cards

1. First
2. Second

• Design the board
  • Assign a priority
  • Add labels
• Break work into cards

1. First
2. Second

Task lists

Use - [ ] for an open item and - [x] for a finished one. Task lists are useful for checklists on a card.

- [x] Draft the spec
- [x] Get sign-off
- [ ] Ship it

• Draft the spec
• Get sign-off
• Ship it

Checkboxes in rendered content are read-only. To change a task, edit the source.

Mentions

Type @ and a username to mention a teammate. Mentions render as a highlighted label. A username can contain letters, numbers, underscores, dots, and hyphens, and must be 2 to 40 characters long.

Thanks @sam, I'll take the next step.

Thanks @sam, I'll take the next step.

Internal links

Wrap text in double square brackets to make a wiki-style link. Use Label|/path to link to a page inside Projavo.

[[Read cards|/docs/api/read-cards]]

Read cards

A wiki link with no |path renders as plain highlighted text, not a link. Only paths that start with / become links, so a wiki link can't send readers to another site.

[[Something to look up later]]

Something to look up later

Tables

Use pipes and hyphens to build a table. Columns line up automatically.

| Priority | Label   | Owner |
| -------- | ------- | ----- |
| High     | Bug     | @sam  |
| Low      | Cleanup | @alex |

Code

Use single backticks for inline code. Use a fenced block with three backticks, and add a language name after the opening fence to get syntax highlighting.

```ts
export function greet(name: string) {
  return `Hello, ${name}`;
}
```

export function greet(name: string) {
  return `Hello, ${name}`;
}

Blockquotes

Start a line with > to quote text.

> A plain quote for citing context or a reply.

A plain quote for citing context or a reply.

Alerts

Alerts highlight information by type. Start a blockquote with one of the five markers below on its own line. The marker is case-insensitive.

> [!NOTE]
> Useful information that readers should know, even when skimming.

> [!TIP]
> Advice that makes a task easier.

> [!IMPORTANT]
> Information needed to reach the goal.

> [!WARNING]
> Something that needs attention to avoid problems.

> [!CAUTION]
> A risky action and its likely outcome.

Images

Embed an image with an exclamation mark, alt text, and an https URL. Images are limited to the width of the content area.

![Board layout](https://example.com/board.png)

This example is shown as source only.

Horizontal rules

Three hyphens on their own line draw a divider between sections.

---

---

Raw HTML

HTML tags aren't rendered. Use markdown for formatting instead.