Markdown editor
  • 19 Oct 2022
  • 3 Minuten zu lesen
  • Mitwirkende
  • Dunkel
    Licht
  • pdf

Markdown editor

  • Dunkel
    Licht
  • pdf

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

To create documents, the Markdown Editor uses Markdown formatting. This short-hand syntax styles text and then converts that text to HTML.

Markdown is handy when major text and mild media are involved in the documentation.

Document360 has another editor - The WYSIWYG editor. You can use this when media involvement is significant in the documentation.

For a list of basic Markdown commands, refer to Markdown basics.


Using Markdown in your Knowledge base

  • When you create a new project, the Markdown editor is set as the project's default editor.

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 or using the Bold icon in the Markdown toolbar.

1_Screengif-Bold_option.gif


  • If you need a quick syntax reference while writing an article, you can view common Markdown commands right in the editor by clicking Shortcut on the bottom left of the screen.

2_Screenshot_Markdown_shortcut


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

For example, In Bold syntax, no space should be present at the end or beginning of the characters mentioned inside the syntax.
In Headings, a space is required between the respective syntax and characters.


Markdown toolbar

Use the Markdown toolbar to format your docs without writing Markdown manually.

3_Screenshot_Markdown_toolbar_item_number1

Headings

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

Basic text formatting

  1. Bold: To Bold the text
  2. Italic: To Italicize the text
  3. Strikethrough: To Strikethrough the text
  4. Blockquote: To offset a quote or paragraph with a line. For example, the below sentence is in Blockquote:

This is an example of Blockquote.

List

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

4_Screenshot_Unordered and Ordered list 1

Insert

  1. Line: To insert a line in the article
  2. Insert Table: To add a table to the article
  3. Insert image: To insert an image from the URL, local Drive, or Document360 Drive. Read more →
  4. Insert file: To insert a PDF or word document from the Drive. Read more →
  5. Insert a link: Add a hyperlink from a provided URL or a Knowledge base article to the selected text. Read more →
  6. Insert Codeblock: Add a code block to your article. Refer to →
  7. Insert Video: To embed a video from YouTube, Wistia, or Vimeo

Callouts

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

Private notes

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

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

Find and Replace

  1. Find and Replace: To 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

  1. Insert LaTeX: To add expressions and equations

    • Click on Insert LaTeX option and a sample latex syntax () appears
      5_Screenshot-Latex_integration_example

    • Type in your desired syntax

    • The syntax must start and end with $

    Don't add a space between $ and syntax.

    • Click here to view the basic latex commands used in latex syntax

Content reuse

  1. 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. Read more →
    b. Snippet: You can add images, tables, etc., inside a snippet. Read more →

Limitation

Markdown editor does not support any third-party spellcheck tool while writing. Please use the WYSIWYG editor to write with third-party spellcheck tools.


War dieser Artikel hilfreich?


What's Next