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

1. Markdown editor
2. WYSIWYG (What You See is What You Get) editor
3. Advanced WYSIWYG editor


  • Markdown editor lets writers use syntax and HTML to customize articles
  • WYSIWYG editor uses Rich Text formatting and includes an extensive formatting toolbar; however, you cannot use custom code in articles
  • Advanced WYSIWYG editor is the latest addition to the editor options in Document360 and acts as a hybrid between the Markdown and WYSIWYG editors.
By default, all projects and articles use the Markdown editor

1. Markdown editor

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

1_Screenshot-Editor_choices_Markdown

  1. The left side of the screen is where you type and apply Markdown syntax
  2. The preview screen on the right side allows you to view how your article will look before publishing it
  3. Scroll on indicates the two sections of the text editor scroll simultaneously as you scroll on one screen. Click Scroll on to turn off the auto-scroll
  4. Click View preview to see your article as it will appear on your Knowledge base site

2_Screenshot-Editor_choices_Markdown_view_preview

  1. Once you publish your article, you can find a Copy link icon next to View in knowledge base icon. This copy link icon is on the category, article, and Index pages.

You can view the rendered output on the left-side window as you type the content on the right-side window. Use the arrows on the divider to collapse either window of the editor.

Scenarios where the Markdown editor is recommended

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

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

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

You can then change the height and width of the image by adding the desired values (For example, height="600px" width="400px"). You can also apply other styles to the image by adding additional HTML and Markdown syntax.

In WYSIWYG mode, you would use the formatting toolbar to insert an image, then click on the image to view options to change the image size and styles. You can better format and style the images with presets such as shadows, borders, and more. This advanced formatting can be achieved in Markdown only when you use HTML customization snippets.


If your article is primarily text-based or needs to insert code blocks or other custom HTML tags, use the Markdown Editor. Use the WYSIWYG editor for easier formatting if your article includes images, videos, tables, or other media.

Refer to the Document360 help articles about Markdown editor for more information


2. WYSIWYG editor

The WYSIWYG stands for What You See Is What You Get, an HTML-based editor different from the Markdown editor in that you can preview the actual article formatting as you type or add the content.

3_Screenshot-Editor_choices_WYSIWYG

Scenarios where "WYSIWYG editor" is recommended

If your team members contributing to the articles are familiar with HTML-based editors such as WordPress, this editor is relatively easy to adapt. Also, if your documentation articles are code-heavy and media-rich, the WYSIWYG editor can offer comprehensive formatting options for text, images, videos, and more.

Refer to the Document360 help article about WYSIWYG editor for more information.


3. Advanced WYSIWYG editor

The 'Advanced WYSIWYG editor' is lightweight and powerful, with rich text editing capabilities, and supports Markdown syntax. It provides a more visual and intuitive experience than the Markdown editor while still being more flexible than the WYSIWYG editor.

The Advanced WYSIWYG editor aligns more with popular tools such as Microsoft Word.

4_Screenshot-Editor_choices_Block_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.

7_Screenshot-Editor_choices_Block_editor_slash_action

Scenarios where "Advanced WYSIWYG editor" is recommended

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

Refer to the Document360 help article on Advanced WYSIWYG editor for more information.


Changing the default editor at project-level

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

  1. From the Knowledge base portal, go to SettingsKnowledge base portalGeneralDocumentation
  2. In Editor section, select Markdown (or) WYSIWYG(HTML) (or) Advanced WYSIWYG editor and click Save

6_Screenshot-Editor_choices_project_level_settings

If you change your project's default editor, all the new articles you create will be in respective editor 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

To switch editors in an individual Article/category page

  1. In the article/category page, click the Article Settings menu icon on the top right
  2. Click Editor and select WYSIWYG(HTML) or Advanced WYSIWYG editor

5_Screenshot-Editor_choices_article_level_setting

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 on the bottom right
You cannot switch from WYSIWYG(HTML)/Advanced WYSIWYG editor to Markdown editor at the article level.

:::


FAQ (Frequently asked questions)

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.


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.


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.


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 the "Switching editor" section in this article.


Do the keyboard shortcuts work in the different Document360 editors?

Yes, all three editors (Markdown, WYSIWYG, and Advanced WYSIWYG editor) come with their own set of keyboard shortcuts. Most conventional shortcuts universally used in tools such as Microsoft Word and Google Docs are available with the Document360 editors.


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.


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

Document360 recommends that you 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

Related Blogs

Introductory Guide to Markdown for Documentation Writers