SapanBaseHelp Center

Format text: headings, inline marks, links, lists & quotes

Writing Articles3 min read · Updated 2 months ago

Headings, inline marks, links, lists, and quotes cover most of what a help article needs. This reference lists each option and how to apply it. The menus and handles themselves are explained in Using the editor: slash menu, bubble menu & block handles.

Headings

The editor offers three heading levels: Heading 1 (large), Heading 2 (medium), and Heading 3 (small). Insert one from the slash menu, or convert an existing paragraph with the block handle's Turn into menu. Three levels match most style guides; if you find yourself wanting a fourth, the article is usually ready to be split in two.

Inline marks

Select the text, then click a mark in the bubble menu. Marks combine freely, so a word can be bold, italic, and highlighted at once.

MarkUse it for
BoldButton labels, menu names, and the one phrase a scanning reader must not miss
ItalicLight emphasis, titles of other works
UnderlineRarely: readers expect underlined text to be a link
StrikethroughText that is superseded but worth leaving visible
HighlightA single highlight colour for drawing the eye to a phrase
Inline codeFile names, commands, field values, and anything typed literally
  1. Select the text that should become the link.
  2. Press ⌘K (Mac) or Ctrl+K (Windows), or click the link button in the bubble menu.
  3. Enter the URL and confirm with Link.

To remove a link, select the linked text and use the same shortcut; it unlinks instead. Typing or pasting a URL turns it into a link on its own, and pasting a URL over selected text links that text. Links open in a new tab for readers, so they never lose their place in your article.

Lists

Insert a Bulleted list or Numbered list from the slash menu, or turn an existing block into one with Turn into. Use numbered lists for steps that happen in order and bulleted lists for everything else.

Quotes

The Quote block is for actual quotations: a pulled statement, a customer's words, a line from a spec. For notes, tips, and warnings aimed at the reader, use a callout instead; it is designed for exactly that and reads more clearly. See Rich blocks: callouts, code, tables, feature cards, embeds & dividers.