Get Started
Get Started

Theme switcher

Accordion

The Accordion Widget is a collapsible content section that helps organize and display information efficiently. Users can click on an accordion title to expand or collapse the content inside, making it an excellent tool for structuring content without overwhelming the reader.

Single Accordion

🚀 Getting Started with the Accordion Widget

Welcome to the Accordion Widget! This feature helps keep your content organized and user-friendly. Below are some key details you can include inside an accordion:

📌 Key Features:

  • Expandable and collapsible sections
  • Supports text, images, callouts, and code blocks
  • Ideal for FAQs, step-by-step guides, and technical documentation

Accordion Group

📌 What is API Documentation?

API documentation provides a detailed guide on how to interact with an API, including endpoint details, request/response formats, authentication methods, and usage examples.

💡 Why is it Important?

  • Helps developers understand API functionality
  • Improves integration efficiency
  • Ensures consistency in API usage

🔑 How to Authenticate API Requests

API Authentication Methods:

  1. API Key: Include an API key in the request headers.
  2. OAuth 2.0: Authenticate via access tokens.
  3. JWT Tokens: Secure authentication with signed tokens.

💡 Example API Key Authentication:

CURL
curl -H "Authorization: Bearer YOUR_API_KEY" https://api.example.com/data

⚠️ Common API Errors

  • 400 Bad Request: Invalid request syntax.
  • 401 Unauthorized: Missing or invalid authentication.
  • 404 Not Found: Requested resource doesn’t exist.
  • 500 Internal Server Error: Unexpected issue on the server.

💡 How to Fix Errors?

  • Double-check request parameters and headers.
  • Ensure authentication credentials are correct.
  • Review API documentation for required inputs

Benefits of Using the Accordion Widget

  • Improves Readability: Helps break down long sections of text into manageable parts.
  • Saves Space: Keeps the interface clean and organized by hiding details until needed.
  • Enhances User Experience: Allows users to navigate and find relevant information quickly.
  • Supports Various Content Types: Can include text, images, videos, callouts, code blocks, and more.

When to Use the Accordion Widget

  • FAQs: Organize frequently asked questions and answers in a structured format.
  • Step-by-Step Guides: Display instructions in a collapsible manner.
  • Technical Documentation: Provide expandable sections for detailed explanations.
  • Product or Feature Descriptions: Allow users to view or hide additional details about a product or service.
  • Policies and Agreements: Present terms and conditions in a collapsible format to improve readability.

Steps to Add an Accordion Widget

1

First step

Navigate to the point in your text where you want to insert the accordion widget.

2

Second step

Type /accordion on a new line.

3

Third step

Select the accordion option that appears.

4

Fourth step

Enter a brief summary title for the accordion widget.

5

Fifth step

Inside the accordion, add content such as text, images, code blocks, callouts, and video embeds.

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Accordion