Formatting Examples

This page demonstrates all available formatting options in our documentation.

This is a formatting sample. All names, options, steps, and values on this page are placeholders. They do not describe a real product or feature.

1. Information Blocks

Highlight important information using colored blocks.

Tip — Helpful advice to make things easier.

Note — Additional information worth knowing.

Important — Pay attention to this before proceeding.

Warning — Critical information to avoid problems.

2. Step-by-Step Instructions

Guide readers through a process with numbered steps.

Prepare the Item

Open the example page and locate the item you want to change.

Fill In the Details

Enter a sample name and a short description in the form fields.

Save the Changes

Select Save to store your changes.

Review the Result

Check the updated item and confirm that it looks as expected.

3. Tabs

Show different options or versions of the same content.

Option A

Sample Option A

Example use case:

1 sample item
Basic feature
Standard support

Quick links to related sections.

Getting Started Account Settings Security Organizations

5. Expandable Sections

Hide additional details that readers can expand when needed.

Which file formats are supported?

This is an example answer. Supported formats in this sample:

Format one
Format two
Format three

How do I undo a change?

Example steps:

Open the example page
Select “Undo”
Confirm your choice

The change is reverted right away.

Can I change this option later?

Yes, this is a sample answer. Changes take effect after the next save.

6. File Structure

Show folder and file organization.

- - Project Plan.pdf
  - Budget.xlsx
  - Presentation.pptx
Notes.txt

7. Tables

Organize data in rows and columns.

Feature	Option A	Option B	Option C
Items	1	10	100
Size	Small	Medium	Large
Support	Basic	Standard	Extended
Custom Setting	No	Yes	Yes

8. Full-Width Content

Content that extends beyond the normal page width.

This block spans the full width of the page, useful for important announcements or wide images.

9. Code Examples

For technical users who need to see code.

Inline code: Use Ctrl+S to save or Cmd+S on Mac.

Code block with syntax highlighting:


{
  "name": "John Smith",
  "email": "john@example.com",
  "mode": "A",
  "active": true
}

10. Combined Example

Here’s how multiple elements work together.

Follow these sample steps to set up an example workspace.

Choose a Mode

Mode A

Use Mode A for a simple example workflow.

Configure the Options

For the example, configure the following:

Sample Options

Review the example options:

Open the example menu
Check the “Sample List”
Remove any item you do not need

Sample Notifications

Set up example notifications:

Daily digest — example summary
Instant alerts — example urgent updates
Weekly report — example overview

Connect an External Service

Connect an example service to sync items:

Service A
Service B
Service C

Invite Collaborators

Example only: invited users would receive a sample message with instructions to join.

Summary

Element	Best Used For
Information Blocks	Highlighting tips, warnings, and important notes
Steps	Guiding users through processes
Tabs	Showing alternatives or options
Cards	Navigation to related content
Expandable Sections	FAQ and optional details
File Structure	Showing file organization
Tables	Comparing features or data
Full-Width Content	Important announcements
Code Examples	Technical information