Skip to main content

Markdown formatting in Favro

Written by Rufus Glaser

Favro's card descriptions and comments support rich text formatting. In the editor, you format text using the toolbar or keyboard shortcuts.

This article covers what formatting is available, how to use it, and what it looks like when you read or write card descriptions through the Favro API.

Formatting available in Favro

Here's a quick overview of every formatting option Favro supports.

How it looks in Favro cards:

How it looks in markdown format:

# Heading 1

## Heading 2

**Bold**

*Italic*

~~Strikethrough~~

[Link](https://www.favro.com)

```
// Code block
```

`inline code`

* Bullet list

* Item 1

* Item 2

|Table Heading|Table Heading|Table Heading|
| --- | --- | --- |
|Multi-line<br>Table cell|Table cell|Table cell|

- [ ] Checklist item

- [x] Multi-line
Checklist item

## Attachments
[Board](https://favro.com/widget/.../...)

[Another card](https://favro.com/organization/.../...?card=Fav-5840)

![image.png](https://favro...

For API developers

Use the descriptionFormat markdown, to

Working with attachments

Attachments in a card description come through as standard markdown syntax.

If you read a description, modify it, and write it back, those references stay intact, provided you did not modify anything related to the attachments.

To add new file attachments, use the dedicated upload endpoints instead: API reference Attachments

Caveats when using markdown API

  • Updating cards through markdown API will remove highlights from all comments.

  • Text alignment in tables is not persisted in markdown

Did this answer your question?