README: document formatted_body for rich-text messages#12
Merged
Conversation
mx_send's plain body shows literal backticks in clients that render rich text via formatted_body (Element, Cinny, etc.). Show the extra = list(format, formatted_body) pattern with a code-block example and link to the spec's allowed-tags list.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a "Sending rich-text" section to the README explaining that markdown fences in plain `body` render as literal backticks; to get an actual code block you have to set `format = "org.matrix.custom.html"` and `formatted_body = "
Background
Discovered while sending a multi-step build script to a Matrix room; the triple-backtick fences showed as literal text. The `extra` arg is the existing solution, just wasn't documented.