Text formatting
Select any text in the editor to reveal the inline formatting toolbar. Available options:
- Bold — emphasise key terms or warning phrases.
- Italic — for titles of other articles, product names, or light emphasis.
- Underline and
strikethrough— use sparingly. Inline code— for short literals: file names, keyboard shortcuts, field names.- Highlight — draw attention to a critical note inside a paragraph.
- Text color — available via the color picker in the toolbar.
Headings and structure
Use headings to break long articles into scannable sections. The article title is automatically rendered as <h1> by the widget — start your body sections at Heading 2.
- Heading 2 — major sections (2–6 per article).
- Heading 3 — sub-sections within an
<h2>. - Heading 4 — rarely needed; consider splitting the article instead.
For articles with five or more <h2> sections, add a table of contents at the top of the body — the editor inserts it as a single <toc> element that expands automatically.
Lists
- Bullet list — parallel items with no natural order (features, prerequisites, options).
- Numbered list — sequential steps where order matters.
- Task list — checklist items with tick boxes, useful for setup checklists.
Lists can be nested by pressing Tab at the start of a list item to indent it.
Tables
Click the table icon in the toolbar to insert a table. Use the right-click context menu on any cell to add or delete rows and columns, merge cells, or set a header row. Tables are automatically wrapped in a horizontal-scroll container on narrow screens, so wide tables are safe to use.
Code blocks
For multi-line code snippets, use a code block (the </> icon in the toolbar). Code blocks are rendered in a monospace font and preserve all whitespace. For a single short literal inside a sentence, use inline code instead.
Images
Click the image icon to upload a file or paste a URL. Images are stored on Yaplet's CDN and displayed inline in the article. Visitors can click any image to open it full-size in a lightbox overlay. See Add images and screenshots for sizing tips and best practices.
Links
Select text and click the link icon to create a link. Paste any https:// URL for external links. To link to another article in the same knowledge base, use the yaplet://article/{article-id} format — the widget intercepts these links and opens the target article in place, without a full page navigation.
The article ID appears in the Share modal on any published article. Fixed links (/k/redirect?id=…) and yaplet:// links both use the same ID.