Text Editor overview
  • 16 Sep 2022
  • 2 Minuten zu lesen
  • Mitwirkende
  • Dunkel
    Licht
  • pdf

Text Editor overview

  • Dunkel
    Licht
  • pdf

There is no German content available for this article, You are viewing the fallback version (English).

Document360 has two text editors for creating and writing articles:

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

Markdown editor lets writers use Markdown 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.

By default, all projects and articles use the Markdown editor

When to use Markdown vs. WYSIWYG

Markdown editor provides a lot of flexibility for article creation and customization. However, the flexibility comes with using markdown syntax or HTML.

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.

If your article is primarily text-based, or if you need 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.

Markdown WYSIWYG
Customization X
Code blocks X
Text-based docs X
Media-heavy docs X
Easier formatting X

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_parts_of_text_editor

  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 disable the auto-scroll

  4. Click View preview to see your article as it will appear on your knowledge base site
    01_New_Parts of Text editor

  5. Once you publish your article, you can find a Copy link icon next to View in knowledge base icon. You can find this copy link icon on the category page, article, and Index page.

As you type the content on the left side, you can view the rendered output on the right side. Use the arrows on the divider to collapse either portion of the editor.


WYSIWYG Text Editor

The WYSIWYG editor is different from the Markdown editor in that what you see when you draft an article will look the same when published.
1_Screenshot_WYSIWYG_Text Editor


Switching between Markdown and WYSIWYG

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

To switch editors in an individual article/category page:

3_Screenshot-Switching_editor_article_level

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

4_Screenshot-Switching_editor_article_level_confirmation

  1. Click Yes in the Change confirmation prompt window and then click Save on the bottom right
You cannot switch from WYSIWYG(HTML) to Markdown at the article level.

To make the WYSIWYG editor the default editor:

WYSIWYG vs Markdown(1)

  1. From the knowledge base portal, go to SettingsKnowledge base portalGeneralDocumentation
  2. In Editor section, select WYSIWYG(HTML) and click Save
If you change to the WYSIWYG editor to be your default project editor, all the new articles you create will be in WYSIWYG(HTML) editor.

Check out the below tutorial video:


* Introductory Guide to Markdown for Documentation Writers


War dieser Artikel hilfreich?


What's Next