Markdown editor

Plans supporting the use of markdown editor

The Markdown Editor uses a short-hand syntax style text to create documents and then converts that text to HTML. Markdown is useful when articles contain more text and fewer multimedia elements.

NOTE

To learn more about Markdown comments, refer to Markdown basics article.

Using Markdown in your Knowledge base

For more information on text editor options, refer to Text editor overview.

• When using the Markdown editor, you can use Markdown syntax manually while writing or formatting text using the Markdown toolbar.

For example, you can make a text appear as Bold by writing the respective syntax (such as **word** or using the Bold icon in the Markdown toolbar.

• When you write a syntax, ensure that the reference matches the required character arrangement.

• To learn more about Markdown syntax, read the Markdown basic syntax page.

For example, In Bold syntax, no space should be present at the end or beginning of the characters mentioned inside the syntax.
**Text** and not ** Text **

In Headings, a space is required between the respective syntax and characters.
### Heading3 and not ###Heading3

Markdown toolbar

You can use the Markdown toolbar to format your docs without writing Markdown manually.

• Headings

• Basic text formatting

• List

• Insert

• Callouts

• Private notes

• Find and replace

• Insert LaTeX

• Content reuse

• Code block

• Glossary

• Video

Headings

1. H2: Refers to Heading 2

2. H3: Refers to Heading 3

3. H4: Refers to Heading 4

Basic text formatting

4. Bold: To Bold the text.

5. Italic: To Italicize the text.

6. Strikethrough: To Strikethrough the text.

7. Blockquote: To offset a quote or paragraph with a line. For example, the below sentence is in Blockquote:

This is an example of Blockquote.

8. Line: To insert a line in the article.

List

9. Unordered list: To make a list denoted with bullet points for each item.

10. Ordered list: To make a list denoted with numbers for each item.

Insert

11. Insert Table: To add a table to the article.

12. Insert image: To insert an image from the URL, local Drive, or Document360 Drive.

13. Insert file: To insert a PDF or Word document from the Drive.

14. Insert a link: Add a hyperlink from a provided URL or a Knowledge base article to the selected text.

15. Insert Video: To embed a video from YouTube, Wistia, or Vimeo.

Callouts

16. Info: To insert an editable blue info box. You can use this to add additional information.

17. Warning: To insert an editable yellow warning box. You can use this to add important information.

18. Error: To insert an editable red error box. You can use this to add essential information.

Private notes

20. Private notes: To insert an editable purple internal comment box that will only be visible to logged-in team members.

For example, you can add internal feedback to the respective team members.

Find and Replace

21. Find and Replace: Search a text within your article and replace it with another text. You can also use this to find the article's text content occurrences. This is particularly handy in long articles.

Insert LaTeX

22. Insert LaTeX: To add expressions and equations,

    • Click on Insert LaTeX option and a sample latex syntax () appears.

    • Type in your desired syntax.

    • The syntax must start and end with $.

    NOTE

    Don't add a space between $ and syntax.

    • Read this help article to view the basic latex commands used in latex syntax.

Content reuse

23. Content reuse: To reuse the content across the project. Two content reuse options are available:
    a. Variable: Only text content can be added inside a variable.
    b. Snippet: You can add images, tables, etc., inside a snippet.

Codeblock

24. Insert Codeblock: Add a code block to your article.

Glossary

25. Glossary: Add a glossary to your article.

Spell checker in Markdown

1. Right click on the misspelled word.

2. The suggestions for corrections will be displayed through your browser's native functions.

3. Click on the suggested correction to apply it as needed.
   

Related blogs

1. The Ins and Outs of Using Markdown for Technical Writing

2. Introductory Guide to Markdown for Documentation Writers

FAQs