Skip to main content

What is markdown

  • Updated

Index:

  1. Generic Markdown
  2. Syntaxes

 

Markdown is a syntax used to standardize and facilitate text formatting on the web.

There are several ways to mark text to be formatted. For example, some channels use *text* to make text bold, others use **text** for the same purpose. This way, when this text is displayed, somewhere on the web, a page or a chat for example, it becomes like this: text.

It is very common in the technology field to use markdown, for example, to create formatted documents, they have their own extension, including: .md 

Generic Markdown

Once we understand what a markdown is, let's talk about this new feature!

As mentioned before, each channel can have its own way of formatting a text. Being so, to create a multi-channel smart contact (same bot for several channels) becomes a bit complicated. Let us cite an example:

Google Business Messages uses the syntax for Markdown bold text: **Some bold text ** 

Whatsapp, on the other hand, uses the following formatting: *text* 

So, how would you build your smart contact on our platform for these two channels? Hard to imagine, right? Maybe using two different bots would be the most viable solution.

For that reason, we created this resource that behaves in a generic way. A single syntax for more than one channel.

The main forms of text formatting were implemented, this way, we standardized the syntaxes based on HTML tags, as shown below: 

Syntaxes

Bold: <b> bold text </b>  

Italic: <i> Italic text </i>

Strikethrough: <strike> strikethrough text </strike> (or can also be used <s> )

Monospaced: <tt> monospaced text </tt>

To use it, just add the tags in the text of your bot and then you will have your text with these formatting!

mceclip0.png

Note: It is worth mentioning that to use markdown in a channel, you must check if the channel provider provides this feature. If it is not available, don't worry because we will ignore the markdown used in the text. Also check the channels and their content types: Blip - Content Types.

 

For more information, visit the discussion on the subject in our community or the videos on our channel. 😊

 

Related articles