Category

How to Format Article Content Using Markdown Editor

Updated:

BoldDesk allows you to format the articles using the following options that are available in the Markdown editor.



Check out this video tutorial for more details.

Jump Link Navigation

Jump links, also known as anchor links, help readers navigate quickly to specific sections within the same BoldDesk article without manually scrolling. This improves readability and user experience, especially for long articles.
Follow the steps below to create jump links using the BoldDesk article editor.

Steps to Create Jump Links in BoldDesk

Create a Table of Contents

  • In the article editor, use Insert Link to add links at the top of the article.
  • In the Web Address field, enter the target heading text prefixed with #.
  • In the Web Address field, separate multiple words using a hyphen (‑).
  • The target heading must use Heading Level 2 or 3.

Set Heading Levels Correctly

  • Use Heading Level 2 or 3 for sections you want to link to.
  • Maintain a consistent heading hierarchy for proper navigation.

Text Formatting

You have the option to make the text bold, italicized, or underlined. You can include bullets and numbers. To apply different font styles for sections of the content, select the text you would like to change, and choose the required font style from the drop-down to apply the changes to the selected text.

Text Formatting.png

Strike

You can either add (~~) before and after the content, as shown in the screenshot below, or use the Strike tool on the toolbar to add a strike line. The Preview button on the toolbar allows you to view the preview as well.

Strike.png

Strike preview.png

Blockquote

To add the blockquote in the article, click the Blockquote tool on the toolbar or add (>) before the content you want to include.

Blockquote.png

Blockquote preview.png

Divider

Click the Divider tool on the toolbar or enter (***) in the article’s content to add a horizontal line between the paragraphs.

Divider.png

Divider Preview.png

Insert Table

Use the Insert table toolbar option to select the number of rows and columns you need in the table grid and insert the table into the content.

Insert table.png

To add a table, use three or more hyphens (—) to create each column’s header, and use pipes (|) to separate each column. For compatibility, you should also add a pipe at the end of the row.

Table.png

Table preview.png

Insert Image

Click on the Insert Image tool on the toolbar to open a dialog box. Then, select the image from your local computer by clicking the Browse button, and then insert the image in the article.

Insert Image.png

If an image looks correct in the Knowledge Base editor preview but appears distorted (especially around corners/edges) after publishing in the Customer Portal, avoid applying heavy inline styling directly on the <img> tag. In some cases, inline styles can override the Knowledge Base’s default styling and cause unexpected rendering in the published article.

Recommended workaround:

  • Re‑edit the article and re‑paste/re‑insert the image without inline styling (use the editor’s Insert Image option where possible).
  • If you must insert an image between text using an <img> tag, keep inline styles minimal (for example, remove padding/border only) and avoid forcing styles such as border-radius unless you have verified the published output.

Insert Code

To insert the code blocks in the article, select the Insert Code option in the toolbar or enter backticks (`). The code block is highlighted with a background.

Insert Code.png

Paste your code into the dialog box, then select the appropriate code type or choose Auto to let the editor automatically detect the language.

Code.png

The output will be as shown:

Output preview.png

Insert File

Click on the Insert File tool on the toolbar to open a dialog box. Then, select the file from your local computer by clicking the browse option, and then insert the file in the article.

Insert file.png

image.png

Insert Video

Click the Insert Video tool on the toolbar to open a dialog box. Enter the video URL and click Insert to insert the video in the article.

Insert Video.png

This option supports embedding videos from YouTube, Loom, Vimeo, and Wistia.

You can adjust the height and width of the YouTube video frame.

Youtube link.png

Youtube video.png

  • The video’s recommended height and width are shown below:
    Height = 315
    Width = 560

Insert Short Videos

You can embed a YouTube Shorts in your KB article using the following format:

https://www.youtube.com/embed/{{shortsId}} 

The video’s recommended height and width are shown below:

Purpose Width Height Aspect Ratio
Small 270px 480px 9.16 (Vertical)
Medium (Default) 360px 640px 9.16
Large 450px 800px 9.16
Full Screen (responsive) 100% auto responsive

When embedding YouTube videos using an iframe, only URLs in the embed format are supported. Therefore, both standard YouTube videos and Shorts must be converted to their respective embed URLs before integration.

Insert Link

Click on the Insert link tool on the toolbar to open the Insert Link dialog. The dialog has the following options:

Insert Link.png

Option Description
URL Type or paste the destination for the link you are creating.
Display Text Type the required text that you want to display for the link.

Fullscreen

The Fullscreen tool stretches the editor to the maximum width and height of the browser window.

Fullscreen.png

Alert Box

The markdown editor has the option to add the following alert boxes:

Options Description
Info Box It helps to highlight the info message in the article.
Warning Box It is used to add a warning message in the article.
Error Box It is used to add an error message in the article.

Alert Box.png

Alert Box.png

Frequently Asked Questions

  1. Does BoldDesk auto‑convert markdown syntax?
    Yes. Markdown syntax is rendered automatically in the article preview.

  2. Can I embed files larger than images?
    Yes. Use Insert File to attach supported files.

  3. Is automatic syntax validation available?
    No. BoldDesk does not validate code syntax; it only formats code blocks visually.

  4. Can I reuse formatting across articles?
    No. Formatting must be applied individually per article.

Related Articles

  1. Formatting the Article Content Using WYSIWYG Editor
  2. How to align the content in Markdown Editor
Was this article useful?
Like
Dislike
Help us improve this page
Please provide feedback or comments
Comments (0)
Access denied
Access denied
Access denied
Access denied

No articles or sections found
No articles or sections found