Articles

Article Editor Formatting Reference

The Userorbit Admin Panel's article editor provides a rich set of formatting options to help you create clear, engaging, and highly scannable help center articles. This guide outlines each available formatting tool and offers tips for optimizing your content for readability.

Properties

  • Headings (H1, H2, H3) — Structural elements — Use headings to organize your content hierarchically. H1 is typically reserved for the article title (automatically applied), H2 for main sections, and H3 for sub-sections. They improve scannability and structure.
  • Bold — Emphasis — Highlight important keywords or phrases for emphasis.
  • Italic — Emphasis — Used for titles, foreign words, or to subtly emphasize text.
  • Underline — Emphasis — Can be used for emphasis, though often associated with hyperlinks. Use sparingly to avoid confusion.
  • Bullet Lists — List — Create unordered lists for items that do not require a specific sequence.
  • Numbered Lists — List — Create ordered lists for step-by-step instructions or items that follow a specific sequence.
  • Links (Internal & External) — Hyperlink — Insert hyperlinks to other articles within your help center (internal) or to external websites. Ensure link text is descriptive.
  • Images — Media — Embed images by uploading files or providing a URL. Options are available for sizing and alignment to fit your content. Use images to visually explain concepts or show UI elements.
  • Embedded Videos (YouTube, Loom) — Media — Integrate videos directly into your articles from platforms like YouTube or Loom. This is ideal for tutorials or demonstrations.
  • Code Blocks — Code — Format multi-line code snippets for technical documentation. Preserves indentation and syntax highlighting (if supported).
  • Inline Code — Code — Use for short code snippets, variable names, or technical terms within a paragraph.
  • Blockquotes — Quotation — Use to highlight quoted text, important notes, or distinct sections of text that stand apart from the main narrative.
  • Tables — Data Structure — Organize data in rows and columns for clear, structured presentation.
  • Dividers/Horizontal Rules — Separator — Insert a horizontal line to visually separate sections of content, improving readability and breaking up long passages.

Examples

Headings:

<h2>Main Section Title</h2>
<h3>Subsection Title</h3>

Text Formatting:

<strong>Bold Text</strong>
<em>Italic Text</em>
<u>Underlined Text</u>

Lists:

<ul>
  <li>Bullet item 1</li>
  <li>Bullet item 2</li>
</ul>

<ol>
  <li>Numbered step 1</li>
  <li>Numbered step 2</li>
</ol>

Links:

<a href="https://example.com">External Link</a>
<a href="#">Internal Article</a>

Inline Code: Use the <code>console.log("Hello");</code> command.

Notes

  • Use Headings for Scannability: Structure your articles with H2 and H3 headings to break up content and allow users to quickly scan for relevant information.
  • Keep Paragraphs Short: Aim for concise paragraphs (3-5 sentences) to improve readability, especially on smaller screens.
  • Use Images & Videos to Show, Not Tell: Whenever possible, use visual aids to demonstrate processes, highlight UI elements, or explain complex concepts more effectively than text alone.
  • Consistency is Key: Maintain a consistent formatting style across all your articles for a professional and user-friendly experience.

Was this page helpful?