Using the text editor in Document360 is essential for creating and managing Knowledge base articles efficiently.

Document360 allows you to draft articles in three versatile editor options:

  1. The Markdown editor lets writers use syntax and HTML to customize articles.

  2. The WYSIWYG (What You See Is What You Get) editor uses rich text formatting and includes an extensive formatting toolbar; however, you cannot use custom code in articles.

  3. The Advanced WYSIWYG editor is the latest addition to the editor options in Document360 and acts as a hybrid between the Markdown and WYSIWYG editors.

Document360 ensures a user-friendly experience that enhances content clarity, consistency, and engagement.


1. Markdown editor

The Markdown editor has a split-screen workspace and features to help you manage an article as you write it.

  1. The left side of the screen is where you type and apply the Markdown syntax.

  2. The preview screen on the right side allows you to view how your article will look before publishing.

  3. The Scroll on indicates that both sections scroll simultaneously. Click Scroll on to turn off auto-scroll.

  4. Click 👁 preview” to see how your article will appear on the knowledge base site.

  5. After publishing, you can find the Copy link 🔗 icon near the View in Knowledge Base icon.

Use the arrows on the divider to collapse either window of the editor.

1_Screenshot-Markdown_editor_new_UI

Recommended Scenarios

The Markdown editor provides guided flexibility for article creation and customization and enforces a consistent writing style and formatting across the documentation. This consistency is crucial for maintaining a professional appearance in product documentation.

For example, you can insert images using the toolbar, which injects the following Markdown:

![Image Alt Text] (Image URL){height="" width=""}.

You can adjust the image size by adding desired values (e.g., height="600px" width="400px"). Advanced formatting, such as shadows and borders, can be achieved with HTML customization snippets.


Note

For more information, refer to the articles on the Markdown editor and Markdown basics.


2. WYSIWYG editor

The WYSIWYG, which stands for What You See Is What You Get, is an HTML-based editor that differs from the Markdown editor. It allows you to view the actual formatting of the article as you type or insert content.

2_Screenshot-WYSIWYG_editor_new_UI

Scenarios where "WYSIWYG editor" is recommended

If team members who contribute to articles are familiar with HTML-based editors like WordPress, this editor is relatively easy to use. Additionally, if your documentation articles contain a lot of code and media, the WYSIWYG editor provides extensive formatting options for text, images, videos, and more.

Note

For more information, read the article on WYSIWYG editor.


3. Advanced WYSIWYG editor

The lightweight and powerful 'Advanced WYSIWYG editor' offers rich text editing capabilities and supports Markdown syntax, providing a more visual and intuitive experience compared to the Markdown editor while maintaining flexibility similar to the WYSIWYG editor.

Type / in the editor, and a list of options appears. You can search for the options by typing command names. Click the desired command or press Enter key to select the command.

3_Screenshot-Advanced_WYSIWYG_editor_new_UI

Scenarios where "Advanced WYSIWYG editor" is recommended

Suppose you have Knowledge base articles with text-centric, code-heavy, and media-rich articles. In such case, the Advanced WYSIWYG editor is a flexible alternative to the Markdown and WYSIWYG. This provides quick syntax-based editing similar to Markdown and broad text and image formatting options like the WYSIWYG editor.

Note

For more information, refer to the Document360 help article on Advanced WYSIWYG editor.


Changing the default editor at the project level

To make the WYSIWYG/Advanced WYSIWYG editor the default editor:

  1. From the Knowledge base portal, go to Settings > Knowledge base portalGeneral.

  2. In the Editor section, choose Markdown (or) WYSIWYG(HTML) (or) Advanced WYSIWYG editor and click Save.

4_Screenshot-settingup_default_editor_in_settings

If you change your project's default editor, all the new articles you create will be in your respective editor's choice.


Switching between Markdown - WYSIWYG - Advanced WYSIWYG editor

Markdown editor is the default editor for all new projects and articles in Document360. If you want to use the WYSIWYG or Advanced WYSIWYG editor, you can switch to it at a project or article level.

Editor switching at article-level

Possible

  • Markdown > WYSIWYG

  • Markdown > Advanced WYSIWYG (only in 'Edit' mode)

  • WYSIWYG > Advanced WYSIWYG (only in 'Edit' mode)

  • Advanced WYSIWYG > WYSIWYG (only in 'Edit' mode)

Not possible

  • WYSIWYG > Markdown

  • Advanced WYSIWYG > Markdown

  • Additionally, there are scenarios where we can't switch the WYSIWYG editor:

    • When an empty article created in the HTML Editor is converted to the Advanced WYSIWYG editor.

    • When the default editor is set to Advanced WYSIWYG, and an article is created in the Advanced WYSIWYG editor.

To switch editors in an individual Article/category page

  1. In the article/category page, click the context menu (•••) icon, and select More article options.

  2. In the Article settings panel, click Editor and select your desired editor.

5_ScreenGIF-switching_editor_in_more_article_options

Note

The Advanced WYSIWYG editor is available only in the switch editor option when the article or category page is in 'Edit' mode.

  1. Click Yes in the Change confirmation prompt window and then click Save.

You cannot switch from WYSIWYG(HTML)/Advanced WYSIWYG editor to Markdown editor at the article level.


FAQ (Frequently Asked Questions)

  1. What is a text editor in Document360's knowledge base?

A tool that allows team accounts to create, edit, and format content for their articles and category pages. Each editor option provides a user-friendly interface to facilitate content creation within the Knowledge base portal.


  1. What are the key features of any text editor for documentation?

Text editors with context to knowledge bases typically offer features such as basic text formatting (bold, italics, underline, strikethrough), text type formatting (headings, callouts lists, tables), media embedding (images, videos), file attachments, code formatting, and most importantly an easy to use interface.


  1. Can I embed images and videos directly within the text editor?

Yes, all the text editors available in Document360 support media embedding. Users can easily add images, videos, and other multimedia elements directly into their articles for better visual appeal.


  1. Can I switch between different text editor options?

You have the option that allows you to choose the editor that best suits your preferences and needs at a project level. You can also switch the editors once at an article level, but switching back has some limitations. Please refer to the "Switching editor" section in this article.


  1. Do the keyboard shortcuts work in the different Document360 editors?

Yes, each of the three editors (Markdown, WYSIWYG, and Advanced WYSIWYG editor) has its collection of keyboard shortcuts. Most conventional shortcuts universally used in tools such as Microsoft Word and Google Docs are available with the Document360 editors.

There are plenty of shortcuts available in Advanced WYSIWYG editor, click here know more.


  1. How do keyboard shortcuts in the editor help in documentation?

Keyboard shortcut, as the name implies, improves efficiency in writing by minimizing the need to use the mouse to perform specific actions and access tools in the article without your fingers leaving the device's keyboard.


  1. How do I choose the right text editor option for my knowledge base?

Consider the following factors before selecting the editor at a project-level or article-level

  • Ease of use

  • Type of documentation you create

  • Media files usage

  • Author familiarity with the editor