Theme switcher

Theneo Web Editor

Theneo's web editor is a rich and intuitive platform, equipped with a variety of widgets that enrich the documentation experience. These widgets add depth and clarity to your API documentation, making it more engaging and informative. You can easily access these widgets by simply going to a new line in the editor and typing /, which brings up the widget options.

Additionally, Theneo's live collaboration feature enables real-time teamwork, allowing multiple users to simultaneously edit, comment, and review documentation. This streamlines the editing process, reduces bottlenecks, and fosters seamless collaboration across teams. Whether you're working in the same room or across different time zones, live collaboration ensures that everyone stays aligned and up to date on changes.

Let's take a look at the widgets available:

Code Block

Perfect for displaying code snippets, helping users und/erstand implementation details in different programming languages.

Here's an example of a formatted code snippet in JavaScript:

JavaScript
const city = "London"; const apiKey = "your_api_key_here";
fetch(https://api.openweathermap.org/data/2.5/weather?q=${city}&appid=${apiKey}&units=metric) .then(res => res.json()) .then(data => { console.log(data.main.temp + "ยฐC"); });

Callout

Draws focus to important information, tips, or warnings, ensuring key messages are not missed.

Single Card

Card Title

This is how the card widget appears, with an icon, title and link. Clicking on this card will take you to the Basics of APIs section.

Double Card

Card Title

Add description here

Card Title

Add description here

Triple Card

Card Title

Add description here

Card Title

Add description here

Card Title

Add description here

Card Grid

Card Title

Add description here

Card Title

Add description here

Card Title

Add description here

Card Title

Add description here

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

Steps

How to Add a Steps Widget

1

First Step

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

2

Second Step

Type /Steps on a new line.

3

Third Step

Select the Steps option that appears.

Table

Feature
Description
Available

Authentication

Secure user login with OAuth2.0

Yes

Rate Limiting

Limits the number of requests per hour

Yes

Data Export

Ability to export data in various formats

No

Real-time Updates

Provides live updates without refreshing

Yes

Multi-Language Support

Documentation available in multiple languages

Coming Soon

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Theneo Web Editor