Getting Started

Welcome to the AI Web Feeds documentation! This site includes powerful features for both human readers and AI agents.

🚀 Quick Start

Get up and running in minutes:

✨ Key Features

📄 PDF Export

• Automatic page discovery - Export all documentation pages
• Clean output - Navigation and UI elements hidden
• Interactive content - Accordions and tabs expanded
• Batch processing - Concurrent exports with rate limiting

🤖 AI & LLM Integration

• Discovery endpoint - /llms.txt for AI agent discovery
• Full documentation - /llms-full.txt with structured format
• Markdown extensions - .mdx and .md for any page
• Content negotiation - Automatic markdown for AI agents
• Page actions - Copy markdown and AI tool integration

📡 RSS Feeds

• Multiple formats - RSS 2.0, Atom 1.0, and JSON Feed
• Auto-discovery - Feeds discoverable via metadata
• Sitewide & docs feeds - Subscribe to all or just docs
• Hourly updates - Fresh content with smart caching

🔗 Link Validation

• Automatic scanning - Validates all documentation links
• Anchor checking - Verifies headings and sections exist
• Component links - Checks links in MDX components
• CI/CD integration - Fail builds on broken links

🔍 SEO & Metadata

• Dynamic OG images - Custom images for every page
• Rich metadata - Complete SEO tags and structured data
• Social sharing - Optimized for Twitter, LinkedIn, Slack
• AI crawlers - Special rules for GPTBot, ClaudeBot, etc.

📊 Mermaid Diagrams

• Multiple diagram types - Flowcharts, sequences, classes, ER diagrams
• Theme-aware - Automatically adapts to light/dark mode
• Interactive - Clickable elements and tooltips
• Simple syntax - Markdown-like diagram definition

🧮 Math Equations

• KaTeX rendering - Fast, beautiful mathematical notation
• Inline & block - Support for both inline $x^2$ and display equations
• LaTeX syntax - Familiar TeX/LaTeX commands
• Self-contained - No external dependencies or fonts

🎯 Built With

• Next.js 15 - Application framework
• Fumadocs - Documentation framework
• Puppeteer - PDF generation
• MDX - Enhanced markdown

📚 Documentation Sections

Features

Detailed guides for each major feature:

• PDF Export - Complete PDF export guide
• AI Integration - Comprehensive AI/LLM integration
• llms-full.txt Format - Structured format specification
• RSS Feeds - Subscribe to documentation updates
• Link Validation - Ensure all links are correct
• SEO & Metadata - Rich metadata and Open Graph images
• Mermaid Diagrams - Create beautiful diagrams with simple syntax
• Math Equations - Render beautiful equations with KaTeX

Guides

Practical how-to guides:

• Quick Reference - Commands and endpoints
• Testing Guide - Verify your setup

🎨 Philosophy

This documentation is designed to be:

• User-friendly - Clear, concise, and well-organized
• Developer-friendly - Code examples and technical details
• AI-friendly - Structured formats and multiple access patterns
• Performance-optimized - Static generation and smart caching

🔗 Quick Links

🤝 Contributing

We welcome contributions! See our Contributing Guide for details.

📝 License

This project is licensed under the MIT License. See the LICENSE file for details.