Formatting text

Note

Here you'll learn how to work with the new Wiki editor. For more information about markup in the old editor, see Markup guide (old editor).

Inline formatting

Formatting Toolbar button Windows shortcuts MacOS shortcuts
Bold text Ctrl + B ⌘ + B
Italic Ctrl + I ⌘ + I
Underlined text Ctrl + U ⌘ + U
Strikethrough text Ctrl + Shift + S ⌘ + Shift + S
Monospaced text — —
Highlighted text — —
Colored text — —

Markup

Result

**Bold**

Bold

_Italic_

Italic

++Underlined++

Underlined

~~Strikethrough~~

Strikethrough

##Monospace##

Monospace

==Highlighted==

Highlighted text

{green}(Color) {violet}(text)

Supported colors:

gray — Gray

yellow — Yellow

orange — Orange

red — Red

green — Green

blue — Blue

violet — Violet

Color text

Superscript^text^

Superscripttext

Subscript~text~

Subscripttext

When formatting text, you can combine markup elements in any order:

**_Text formatting 1_** and **_Text formatting 2_**

{orange}(~~Strikethrough part~~ of the orange text)
Result

Text formatting 1 and Text formatting 2

Strikethrough part of the orange text

Headings

An anchor is generated automatically for each header. You can add a link to the anchor from other page parts or other pages. You can also set the anchor manually in the markup mode.

A heading can be level 1 to 6. The higher the level, the larger the font.

To format a heading, use one of the following methods:

  • Click on the toolbar at the top of the page and select the heading's level.

  • Use keyboard shortcuts:

    • Windows: Ctrl + Shift + 1—6
    • macOS: ⌘ + ⌥ + 1—6

    You can also add formatting elements using your keyboard or through the quick access menu: type / and select an item from the list.

To hide some information on the page, you can make the heading collapsible:

  1. Select the heading. A toolbar for editing the selected element appears.

  2. Click on the toolbar.

Content under the heading can be collapsed or expanded. In the editor, the lower boundary of text that will be included in the collapsible block is marked with the icon with a dotted line.

# First-level heading
##+ Collapsible second-level heading
#### Fourth-level heading with an anchor {#level4}

  • To format a heading, add one to six # characters at the beginning of the relevant line.

  • To make a heading collapsible, add + after the # characters.

  • To set a heading's anchor manually, add the {#<anchor_name>} markup at the end of the line.

Lists

To add a list, select one or more paragraphs and use the toolbar buttons or keyboard shortcuts.

You can also add formatting elements using your keyboard or through the quick access menu: type / and select an item from the list.

List Toolbar button Windows shortcuts MacOS shortcuts
Bulleted list Ctrl + Shift + L ⌘ + Shift + L
Numbered list Ctrl + Shift + M ⌘ + Shift + M
Decrease indent Shift + ⇥ Shift + ⇥
Increase indent ⇥ ⇥
Checklist (checkbox) — —

Example

Result

Numbered list

 
1. First item
1. Second item
   1. First sub-item
   1. Second sub-item
  1. First item
  2. Second item
    1. First sub-item
    2. Second sub-item

Bulleted list

 
* List item
  - Sub-item
  - Sub-item
+ List item.
  • List item
    • Sub-item
    • Sub-item
  • List item

Combined list

 
1. Numbered item
   * Bulleted sub-item
   * Bulleted sub-item
1. Ordered list item
  1. Ordered list item
    • Bulleted sub-item
    • Bulleted sub-item
  2. Numbered item

Checklist

 
[ ] Task 1

[x] Task 2

[ ] Task 3

Task 1

Task 2

Task 3

To add a list, use numbers and special characters:

  • For a numbered list, use digits with either . or ) symbol. Numbering is done dynamically, so the order of the numbers doesn't matter.
  • For a bulleted list, use *, -, or +.
  • For a nested list, add two to five spaces before every nested list item. You can have a bulleted list inside a numbered list and the other way around.
  • For a checklist, use [ ] as the marker. There must be an empty line between list items.
    To check off a list item, add x between the brackets instead of a space.

Code formatting

To add a code block, select a line or paragraph and use the following toolbar buttons or keyboard shortcuts:

You can also add formatting elements using your keyboard or through the quick access menu: type / and select an item from the list.

Block Toolbar button Windows shortcuts MacOS shortcuts
Code block Ctrl + Alt + E ⌘ + ⌥ + E
Line of code in text Ctrl + E ⌘ + E

Example

Result

Inline code

Inline code `s = input()`.

Inline code s = input().

Code block

 
```sql
price= '2000'
size= '24'  
color= 'primary'
variant= 'detailed'
```

price= '2000'
size= '24'  
color= 'primary'
variant= 'detailed'

  • To insert a code snippet as inline text, use the symbol. ` .

  • To format code as a separate block, enclose it with symbols. ``` . To enable syntax highlighting, specify the programming language in the first line of the block.

  • All markup characters in a code fragment are automatically escaped. To show the ` symbol as plain text rather than a code indicator, use escape characters.

Formulas

Click on the toolbar and choose your preferred design:

  • Formula in text to embed your formula on the page.

  • Block with formula to embed your formula in a separate block.

You can also add formatting elements using your keyboard or through the quick access menu: type / and select an item from the list.

Example

Result

Line with formula

Formula in text $e^{ix}=\cos x+i\sin x$

Formula in text eix=cos⁡x+isin⁡xe^{ix}=\cos x+i\sin x

Block with formula

 
$$
(√a)^2 = a;
$$

(√a)2=a;(√a)^2 = a;
  • To add mathematical formulas inline, use the character $.
  • To add mathematical formulas as a separate block, enclose it in the characters $$.

To create formulas, use the Katex syntax that is compatible with the TeX/LaTeX format.

Users

To reference someone from your organization, type @ and begin entering their name or login, then select them from the dropdown list.

To reference someone from your organization, type the @ symbol followed by the employee's login: @login.

Separator

To add a paragraph separator, on the toolbar, click Other actions, then select Separator.

You can also add formatting elements using your keyboard or through the quick access menu: type / and select an item from the list.

To add a separator, enter three or more hyphens (-), asterisks (*), or underscores (_) at the beginning of the relevant line:

Separator 1

---

Separator 2

****

Separator 3

____

Emoji

To add an emoji to the page:

  1. On the toolbar, click Other actions, then select Emoji.
  2. Select the emoji you want to add.

Tip

If the cursor is at the beginning of the line or follows a space, type : and select an emoji from the list.

You can also use the quick access menu: type / and select a command from the list.

To add an emoji to your page, enter its name enclosed in colons,

such as :smile:.

Escaping

In Markdown mode, use escaping to show characters that represent markup elements:

  • To prevent interpretation of markup characters, escape them with \:

    Superscript^text^
Superscript\^text^
    Result

    Superscriptindex
    Superscript^index^

  • If you want to display a backtick inside a code fragment, enclose the code in double backticks ``:

    ``SELECT `id` FROM `table` ``

    Result

    SELECT `id` FROM `table`

Hidden text

In Markdown mode, you can hide parts of text from other users. Hidden content will only be visible to users editing the text, and only when in markup mode.

To hide text, use the following markup.

[//]: # (Hidden text)

Note that there should be an empty line before the hidden text.

This can be useful for adding notes to yourself or your collaborators, or for temporarily removing irrelevant text.

You can also leave comments, which are visible to all users with access to the page. For more information about adding comments, see Comments.

Previous
Overview
Next
Block formatting