Markdown editor

Plans supporting the use of Markdown editor

Professional	Business	Enterprise

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 Basic Markdown syntax article.

Using Markdown in your Knowledge base

For more information on text editor options, refer to Editor choices in Document360.

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 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

The WYSIWYG toolbar offers various options to edit and format your text including the option to insert media files as well. The different toolbar sections and their uses are shown and elaborated below.

Headings
Basic text formatting
List
Insert
Callouts
Private notes
Find and replace
Insert LaTeX
Content reuse
Code block
Glossary
Video

Headings

H2: Refers to Heading 2
H3: Refers to Heading 3
H4: Refers to Heading 4

Basic text formatting

Bold: To Bold the text.
Italic: To Italicize the text.
Strikethrough: To ~~Strikethrough~~ the text.
Blockquote: To offset a quote or paragraph with a line. For example, the below sentence is in Blockquote:
This is an example of Blockquote.
Line: To insert a line in the article.

List

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

Insert

Insert Table: To add a table to the article.
Insert image: To insert an image from the URL, local Drive, or Document360 Drive.
Insert file: To insert a PDF or Word document from the Drive.
Insert a link: Add a hyperlink from a provided URL or a Knowledge base article to the selected text.

Callouts

Info: To insert an editable blue info box. You can use this to add additional information.
Warning: To insert an editable yellow warning box. You can use this to add important information.
Error: To insert an editable red error box. You can use this to add essential information.

Private notes

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.

Insert LaTeX

Insert LaTeX: To add expressions and equations,
1. Click on Insert LaTeX option and a sample latex syntax () appears.
2. Type in your desired syntax.
3. The syntax must start and end with $.
NOTE
Don't add a space between $ and syntax.
- Read the help article to view the basic latex commands used in latex syntax.

Find and Replace

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.

Content reuse

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

Insert Codeblock: Add a code block to your article.

Glossary

Glossary: Add a glossary to your article.

Video

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

Scroll

Scroll on/off: To enable or disable simultaneous scroll functionality for both the editor and the article preview sections.

Spell checker in Markdown

Right-click on the misspelled word.
The suggestions for corrections will be displayed through your browser's native functions.
Click on the suggested correction to apply it as needed.

FAQs

What is a Markdown editor, and how does it differ from a regular text editor?

Markdown editor is a specialized text editor designed to simplify the process of writing in Markdown language — a lightweight markup language that converts plain text into HTML. Unlike regular text editors, Markdown editors provide live previews, making it easier to visualize how the content will appear once published. You can experience the full potential of the Markdown editor on Document360 using the customization solution objects help articles we offer.

What are the key features of the Markdown editor in Document360?

Markdown editor in Document360 includes real-time previews, syntax highlighting, keyboard shortcuts, drag-and-drop image support, and seamless integration with the article version control (revisions) feature.

Is a Markdown editor suitable for beginners with no syntax-based writing experience?

Absolutely! Markdown's simple syntax makes it accessible for beginners without coding experience. Its intuitive structure allows users to focus on content creation without learning complex markup languages.

How do I add ASCII code to my article?

You can add ASCII code to your article using the Code Block feature.

Is it possible to add a code block without any heading?

Yes, when using Markdown editor, you can add code blocks in your article without necessarily having any heading.

Can I use the HTML content in the Markdown editor?

Yes, you can use HTML content in the Markdown editor. However, using Markdown syntax in the Markdown editor is recommended to avoid inconsistency.