Changelog

Introducing Global Language Sync: Code Language Preferences That Follow You

Starting today, when you select a programming language in any <CodeBlocks> or <Tabs>, that preference will automatically sync across all documentation pages. This means no more manually switching languages as you navigate through different sections of our docs. Whether you’re viewing implementation examples, debugging guides, or API references, your preferred language follows you. Language preference is kept in client-side local storage.

This behavior is automatically enabled for all <CodeBlocks>. To add language preferences to a <Tab>, you can add the language property. Check out language sync in the example below:

1
console.log("Hello, world!");

1
console.log("This content is synced!");

Improvements to the Accordion Component

The accordion component has been upgraded so that you can now use your in-browser cmd+f search to look for text that is otherwise hidden.

• Improved accessibility for all of our customers who are leveraging the <Accordion> component
• Improved SEO indexing of content (more html is now generated on the server-side instead of client-side)

Try searching for burst on this page: https://dev.hume.ai/docs/expression-measurement/faq

Support for embedding local assets

We’ve added support for embedding local assets in your docs. This is useful for displaying PDFs, images, videos, and other assets into your docs.

To embed an asset, you can use the embed tag.

1
<embed src="./path/to/asset.pdf" type="application/pdf" />
2
<embed src="./path/to/asset.mp4" type="video/mp4" />
3
<embed src="./path/to/asset.png" type="image/png" />

Read more here

Support for /llms.txt

API Docs should be for LLMs and Agents too, not just people!

We’re excited to announce compatibility with the /llms.txt emerging standard, making your documentation accessible and optimized for AI developer tools such as Cursor, Github Copilot, ChatGPT, Perplexity, and Anthropic’s Claude.

Both /llms.txt and /llms-full.txt are designed to be token-efficient, ensuring faster processing and cost-effective LLM interactions without sacrificing valuable info.

If you use Fern Docs, this feature is auto-enabled like /robots.txt and /sitemap.xml. Learn more

Check out ElevenLabs:

Audio Streaming in API Explorer

Added support for streaming audio directly within the API Explorer. This feature enables testing audio endpoints without leaving the documentation.

Check it out live in ElevenLabs’ API Explorer to let users test text-to-speech endpoints and hear the results instantly.

Form Data Optimization

Enhanced handling of URL parameters and form data in edge functions. Documentation playground now handles complex data structures more efficiently.

1
const formConfig = {
2
  encoding: 'application/x-www-form-urlencoded',
3
  arrayFormat: 'brackets',
4
  allowNullables: true,
5
  sanitize: true,
6
  maxDepth: 5
7
}

Auto-Populate Credentials in API Explorer

Save developers the hassle of finding and copying their API key. When authenticated, their API credentials will be automatically filled into the API Playground. This way, they can make their first API call even faster.

Check it out live in Webflow’s API Explorer.

Card Component System

Enhanced documentation card components for better visual organization. Information can now be presented in a more structured and appealing way.

1
interface CardProps {
2
  title: string;
3
  description: string;
4
  icon?: IconName;
5
  variant?: 'default' | 'bordered' | 'filled';
6
  actions?: CardAction[];
7
}
8
9
interface CardAction {
10
  label: string;
11
  href?: string;
12
  onClick?: () => void;
13
}

JWT API Key Integration

Implemented automatic API key extraction from JWT tokens in the documentation playground. Users can now test authenticated endpoints more easily with automatic credential handling.

Query Parameter Enhancement

Improved handling of query parameters in documentation middleware. Complex query parameters are now properly handled and displayed in the documentation.

September 2024

Environment Testing Interface

Created an editable playground environment system for testing API endpoints. Users can now switch between different API environments seamlessly within the documentation.

1
servers:
2
  - url: https://api.example.com
3
    x-fern-server-name: Production
4
  - url: https://sandbox.example.com
5
    x-fern-server-name: Sandbox

August 2024

Anchor Link System

Redesigned anchor link handling for improved navigation within documentation pages. Links now account for fixed headers and maintain proper scroll position when opened.

WCAG Contrast Improvements

Enhanced color contrast throughout the documentation platform for better accessibility. All text and interactive elements now meet WCAG AA standards by default and warnings are shown for any elements that do not meet WCAG AA standards.

API Page Center Updates

Improved center element positioning and updates for API documentation pages. Content now flows more naturally and maintains position during navigation.

Streaming Toggle Enhancement

Improved visibility and behavior of streaming response toggles in API playground. Users can now better control and monitor streaming responses.

July 2024

Meta Image System

Implemented comprehensive meta image support for better social sharing. Documentation pages now display properly when shared on social media platforms.

1
og:image: /assets/og-image.png
2
og:type: documentation
3
twitter:card: summary_large_image
4
twitter:image: /assets/twitter-card.png

June 2024

RSS Feed Integration

Added support for RSS feeds to keep users updated on documentation changes. Teams can now offer automated notifications for their documentation.

JSON-LD Enhancement

Implemented structured data support through JSON-LD for improved SEO. Documentation pages now provide richer information to search engines and social platforms.

1
{
2
  "@context": "https://schema.org",
3
  "@type": "TechArticle",
4
  "headline": "API Authentication Guide",
5
  "datePublished": "2024-06-15",
6
  "technicalAudience": "Software Developers"
7
}

Image Zoom Controls

Added configurable image zoom functionality with custom triggers and behaviors. Users can now better examine diagrams and technical illustrations in documentation.

1
--- 
2
no-image-zoom: true
3
---

Syntax Extension Support

Added support for additional syntax highlighting languages including BAML and Jinja. Documentation can now properly display a wider range of code examples.

1
<body>
2
    <h1>Available Products</h1>
3
    {% if products %}
4
        <ul>
5
            {% for product in products %}
6
                <li class="product">
7
                    <h2>{{ product.name }}</h2>
8
                    <p class="price">${{ product.price }}</p>
9
                    <p>{{ product.description }}</p>
10
                    {% if product.in_stock %}
11
                        <p><strong>Status:</strong> In Stock</p>
12
                    {% else %}
13
                        <p><strong>Status:</strong> Out of Stock</p>
14
                    {% endif %}
15
                </li>
16
            {% endfor %}
17
        </ul>
18
    {% else %}
19
        <p>No products are available at the moment.</p>
20
    {% endif %}
21
</body>