Accordion
The Accordion widget tucks content into collapsible sections, ideal for FAQs and optional detail.
Single accordion
🚀 Getting Started with the Accordion Widget
🚀 Getting Started with the Accordion Widget
Welcome to the Accordion widget! It keeps your content organized and user-friendly. A few things you can include inside:
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?
What is API Documentation?
API documentation is a detailed guide on how to interact with an API: endpoint details, request/response formats, authentication methods, and usage examples.
Why it matters:
- Helps developers understand API functionality
- Improves integration efficiency
- Ensures consistency in API usage
🔑 How to Authenticate API Requests
🔑 How to Authenticate API Requests
Common methods:
- API Key: include an API key in the request headers.
- OAuth 2.0: authenticate via access tokens.
- JWT Tokens: secure authentication with signed tokens.
Example API key authentication:
curl -H "Authorization: Bearer YOUR_API_KEY" https://api.example.com/data
⚠️ Common API Errors
⚠️ Common API Errors
- 400 Bad Request: invalid request syntax.
- 401 Unauthorized: missing or invalid authentication.
- 404 Not Found: the requested resource doesn't exist.
- 500 Internal Server Error: an unexpected issue on the server.
How to fix errors:
- Double-check request parameters and headers.
- Ensure authentication credentials are correct.
- Review the API documentation for required inputs.
Why use it
- Improves readability: breaks long sections into manageable parts.
- Saves space: keeps the interface clean by hiding detail until needed.
- Better UX: readers find what they need quickly.
- Flexible content: supports text, images, video, callouts, code blocks, and more.
When to use it
FAQs, step-by-step guides, technical documentation, product or feature descriptions, and policies or agreements.
Add an Accordion widget
1
Position your cursor
Go to the point where you want to insert the accordion.
2
Type /accordion
Type /accordion on a new line.
3
Select the widget
Choose the accordion option that appears.
4
Add a title
Enter a short summary title for the accordion.
5
Add content
Inside the accordion, add text, images, code blocks, callouts, and video embeds.
On this page
- Accordion