The chat bubbles of all agents made with Chatwith support Markdown. This means that you can add text formatting like bold or italic, but also elements like tables or images.
Read on to learn more about different options for using Markdown with your Chatwith Agent!
Table of Contents
Table of ContentsWhere Markdown is supportedSupported Markdown elementsText stylingLinksImagesTablesBlockquotesCodeVideos
Looking for a quick Markdown reference document? Check this: https://www.markdownguide.org/basic-syntax/
Where Markdown is supported
Markdown is supported in both the bot's responses and user message bubbles. This means you can format the prompts that you send to your bot, and the bot can return richly formatted text back to you. Places where Markdown is supported at Chatwith:
- Training sources: if you provide your files in Markdown format then the agent will use your formatting in generating responses. Websites are automatically scraped into Markdown format by us.
- Refinements: If you provide answers that contain Markdown formatting then your agent will use it to generate the answer.
- Welcome message: You can add styled elements in the first message sent by the agent. This can be used to immediately share your most popular links etc.
- Conversation Starters: If you create a conversation starter that contains Markdown formatting then a message sent by the user will automatically be formatted using it.
- Action responses: if an Action returns structured data (eg. JSON) then your agent will attempt formatting it to make it more readable by creating bullet points or tables. You can provide further instructions when creating an Action.
You can further strengthen your agent’s Markdown usage by providing specific instructions in the System Prompt.
Supported Markdown elements
Below is a compilation of different examples of Markdown formatting that can be used for formatting the chat bubble text. Please note that more Markdown elements may be supported that are not listed here. Refer to online documentation for more advanced examples.
Text styling
You can style your text with bold, italic, and strikethrough effects. For bold text, wrap your text in double asterisks like this).
**this** (this). For italic text, wrap your text in single asterisks or underscores like *this* or _this_ (this). To strikethrough your text, use double tildes ~~this~~ (Links
You can create hyperlinks by wrapping the link text in brackets followed by the URL in parentheses, like
[this](http://example.com)Images
Images can be added by using the syntax
, where the URL is the link to the image and the Alt Text is the description of the image that will be displayed if the image can't be loaded.Tables
Tables can be created by using the pipe symbol to separate cells and hyphens to create headers. For example, a basic table could look like this:
| Column 1 | Column 2 | | -------- | -------- | | Cell 1 | Cell 2 |
Blockquotes
Blockquotes can be created by starting a line with the
> character.This is a blockquote.
Code
Code can be added by wrapping it in backticks. For inline code, use single backticks like
this (\this`). For block code, wrap your code in triple backticks ````: This is a block of codeVideos
Embedding videos is not directly supported. However, you can mimic the feature and embed the video frame + a link. Here is an example Markdown for a YouTube video:
[](https://www.youtube.com/watch?v={YOUTUBE_VIDEO_ID})
Tip: In the Markdown expression above alternatively you can use URL in format:
https://i.ytimg.com/vi/${YOUTUBE_VIDEO_ID}/maxresdefault.jpg to get a video thumbnail instead of a video frame.