Formatting

Outline’s approach to documentation is that formatting should be focused on semantics and meaning rather than decorative elements. For example, you can create “notice” blocks to provide info and warnings like the following…

This approach helps to ensure that docs in your workspace stay consistent and readable – even on larger teams!

This is an example notice

Toolbar

The formatting menu appears when selecting text

The formatting menu appears when selecting text

When you select text in the editor a toolbar will appear, this toolbar contains all the common inline formatting options you would expect. If you have commenting enabled a control to add comments to a text selection will also be visible on the right of this toolbar.

Inline formatting

  • bold

  • italic

  • strikethrough

  • highlighting in a variety of different colors

  • monospace

  • underlined

Markdown

We support all Markdown elements in the text editor. Write in Markdown or paste it directly and it will be converted into rich text automatically. For example ** to apply bold, or ## at the beginning of a line for headings. If you’ve used other modern text editors you’ll feel at home.

For a full list of markdown syntax open the keyboard shortcut guide with ? or by clicking the keyboard icon that appears in the bottom right of the app when editing a document.

Keyboard shortcuts

For a full list of keyboard shortcuts open the keyboard shortcut guide with ? or by clicking the keyboard icon that appears in the bottom right of the app when editing a document.