Formatting Examples
This page demonstrates all available formatting options in our documentation.
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.
Create an Account
Go to the registration page and fill in your details: name, email, and password.
Verify Your Email
Check your inbox for a verification email and click the confirmation link.
Complete Your Profile
Add your photo and personal information to personalize your account.
Start Using the System
You’re ready! Explore the available features and settings.
3. Tabs
Show different options or versions of the same content.
For Individuals
Individual Plan
Perfect for personal use:
- 1 user account
- Basic features
- Email support
4. Navigation Cards
Quick links to related sections.
5. Expandable Sections
Hide additional details that readers can expand when needed.
What payment methods do you accept?
We accept the following payment methods:
- Credit and debit cards (Visa, MasterCard, American Express)
- PayPal
- Bank transfer
- Cryptocurrency (Bitcoin, Ethereum)
How do I cancel my subscription?
To cancel your subscription:
- Go to Account Settings
- Click “Subscription”
- Select “Cancel Subscription”
- Confirm your choice
Your access continues until the end of the billing period.
Can I change my plan later?
Yes! You can upgrade or downgrade your plan at any time. Changes take effect at the start of your next billing cycle.
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 | Basic | Pro | Enterprise |
|---|---|---|---|
| Users | 1 | 10 | Unlimited |
| Storage | 5 GB | 50 GB | 500 GB |
| Support | Priority | Dedicated | |
| API Access | No | Yes | Yes |
| Custom Branding | No | No | 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",
"plan": "pro",
"active": true
}10. Combined Example
Here’s how multiple elements work together.
Follow these steps to set up your workspace.
Choose Your Plan
Monthly
Pay month-to-month with flexibility to cancel anytime.
Configure Your Settings
For the best experience, configure the following:
Security Settings
Enable two-factor authentication to protect your account:
- Go to Settings → Security
- Click “Enable 2FA”
- Scan the QR code with your authenticator app
Notification Preferences
Set up email notifications:
- Daily digest — summary of all activity
- Instant alerts — important updates only
- Weekly report — performance overview
Calendar Integration
Connect your calendar to sync events:
- Google Calendar
- Microsoft Outlook
- Apple Calendar
Invite Your Team
Team members will receive an email invitation 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 |