${{ product.price }}
+{{ product.description }}
+ {% if product.in_stock %} +Status: In Stock
+ {% else %} +Status: Out of Stock
+ {% endif %} +No products are available at the moment.
+ {% endif %} + +``` \ No newline at end of file diff --git a/fern/pages/changelogs/docs/2024-07-30.mdx b/fern/pages/changelogs/docs/2024-07-30.mdx new file mode 100644 index 00000000000..42604e12b50 --- /dev/null +++ b/fern/pages/changelogs/docs/2024-07-30.mdx @@ -0,0 +1,37 @@ +# 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. + +```yaml +og:image: /assets/og-image.png +og:type: documentation +twitter:card: summary_large_image +twitter:image: /assets/twitter-card.png +``` + +## Type-Safe Components +Implemented strict TypeScript checking for documentation components. This ensures more reliable documentation rendering and easier maintenance. + +```typescript +interface CodeBlockProps { + language: SupportedLanguage; + fileName?: string; + showLineNumbers: boolean; + highlight?: number[]; + maxHeight?: number; +} +``` + +## Base Path Handling +Improved handling of base paths for search records and navigation. + +```typescript +const pathConfig = { + stripBasePath: true, + rewriteRules: [ + { from: '/api/', to: '/reference/' }, + { from: '/v1/', to: '/v2/' } + ] +} +``` \ No newline at end of file diff --git a/fern/pages/changelogs/docs/2024-08-20.mdx b/fern/pages/changelogs/docs/2024-08-20.mdx new file mode 100644 index 00000000000..d6df319f846 --- /dev/null +++ b/fern/pages/changelogs/docs/2024-08-20.mdx @@ -0,0 +1,46 @@ +# 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. + +```typescript +const anchorConfig = { + offset: 100, + smooth: true, + behavior: 'auto', + preserveHash: true +} +``` + +## WCAG Contrast Improvements +Enhanced color contrast throughout the documentation platform for better accessibility. All text and interactive elements now meet WCAG AA standards. + +```css +:root { + --text-primary: #1a1a1a; + --text-secondary: #4a4a4a; + --link-color: #0056b3; + --code-inline: #bf1363; +} + +[data-theme='dark'] { + --text-primary: #ffffff; + --text-secondary: #e0e0e0; + --link-color: #66b3ff; + --code-inline: #ff6b9d; +} +``` + +## API Page Center Updates +Improved center element positioning and updates for API documentation pages. Content now flows more naturally and maintains position during navigation. + +```typescript +const centerElementConfig = { + updateThreshold: 0.2, + scrollBehavior: 'smooth', + debounceTime: 100 +} +``` + +## Streaming Toggle Enhancement +Improved visibility and behavior of streaming response toggles in API playground. Users can now better control and monitor streaming responses. diff --git a/fern/pages/changelogs/docs/2024-09-24.mdx b/fern/pages/changelogs/docs/2024-09-24.mdx new file mode 100644 index 00000000000..7a15acfde95 --- /dev/null +++ b/fern/pages/changelogs/docs/2024-09-24.mdx @@ -0,0 +1,24 @@ +# 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. + +```yaml openapi.yml +servers: + - url: https://api.example.com + x-fern-server-name: Production + - url: https://sandbox.example.com + x-fern-server-name: Sandbox +``` + +## Server Upload Validation +Improved file upload handling with better validation in documentation examples. Users can now better understand and test file upload endpoints. + +```typescript +const uploadConfig = { + maxSize: '10MB', + allowedTypes: ['image/*', 'application/pdf'], + validateBeforeUpload: true, + showProgress: true +} +``` \ No newline at end of file diff --git a/fern/pages/changelogs/docs/2024-10-31.mdx b/fern/pages/changelogs/docs/2024-10-31.mdx new file mode 100644 index 00000000000..288b4b61fee --- /dev/null +++ b/fern/pages/changelogs/docs/2024-10-31.mdx @@ -0,0 +1,19 @@ +# October 2024 + +## 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. + +```typescript +const jwtConfig = { + extractApiKey: true, + tokenLocation: 'header', + autoRefresh: true, + schema: { + apiKeyPath: 'payload.api_key', + rolePath: 'payload.permissions' + } +} +``` + +## Query Parameter Enhancement +Improved handling of query parameters in documentation middleware. Complex query parameters are now properly handled and displayed in the documentation. \ No newline at end of file diff --git a/fern/pages/changelogs/docs/2024-11-27.mdx b/fern/pages/changelogs/docs/2024-11-27.mdx new file mode 100644 index 00000000000..45812b350ab --- /dev/null +++ b/fern/pages/changelogs/docs/2024-11-27.mdx @@ -0,0 +1,44 @@ +## 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](https://developers.webflow.com/data/reference/sites/list?playground=/data/reference/sites/list). + +## Domain Management +Implemented comprehensive domain cleanup and management system. Documentation now handles multiple domains and environments more effectively. + +```typescript +const domainConfig = { + cleanup: { + frequency: 'daily', + retainDays: 30, + backupBeforeClean: true + }, + routing: { + primary: 'docs.example.com', + aliases: ['api-docs.example.com'], + forcePrimary: true + } +} +``` + +## Card Component System +Enhanced documentation card components for better visual organization. Information can now be presented in a more structured and appealing way. + +```typescript +interface CardProps { + title: string; + description: string; + icon?: IconName; + variant?: 'default' | 'bordered' | 'filled'; + actions?: CardAction[]; +} + +interface CardAction { + label: string; + href?: string; + onClick?: () => void; +} +``` diff --git a/fern/pages/changelogs/docs/2024-12-30.mdx b/fern/pages/changelogs/docs/2024-12-30.mdx new file mode 100644 index 00000000000..f75c355bce7 --- /dev/null +++ b/fern/pages/changelogs/docs/2024-12-30.mdx @@ -0,0 +1,17 @@ +## 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](https://elevenlabs.io/docs/api-reference/text-to-speech/convert?playground=/docs/api-reference/text-to-speech/convert-as-stream) 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. + +```typescript +const formConfig = { + encoding: 'application/x-www-form-urlencoded', + arrayFormat: 'brackets', + allowNullables: true, + sanitize: true, + maxDepth: 5 +} +``` \ No newline at end of file diff --git a/fern/pages/changelogs/docs/2025-01-14.mdx b/fern/pages/changelogs/docs/2025-01-14.mdx new file mode 100644 index 00000000000..315aa9c9bb4 --- /dev/null +++ b/fern/pages/changelogs/docs/2025-01-14.mdx @@ -0,0 +1,31 @@ +## 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](https://llmstxt.org/), 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](https://buildwithfern.com/learn/docs/developer-tools/llms-txt) + + + +Check out ElevenLabs: + +