Skip to content

Tilenk/update rich text docs #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 24, 2025
Merged

Tilenk/update rich text docs #8

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a03c5b8
Update docs to clarify rich text transformation method
tilenkavcic Feb 24, 2025
d9b8292
Update supported_types.md
tilenkavcic Feb 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/supported_types.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ DevRev supports the following types:
- Rich text is used in DevRev to represent text fields that can be formatted and can contain mentions. Eg.: description of an issue, body of a conversation, etc.
- A simple rich text looks like one markdown string wrapped in an array: `["Hello **world**!"]`.
Markdown should be compatible with [CommonMark Spec v0.30](https://spec.commonmark.org/0.30).
- To support mentions `rich_text` can be formatted as an array of strings and mention objects like so:
- To support mentions `rich_text` can be formatted as an array of strings and mention objects. The field should also use the *use rich text* transformation method.
- Example of a simple mention object:
```json
[
"Hello ",
Expand Down