A minimalist, real-time markdown-based website generator designed for seamless content updates without rebuilds. It targets developers and content creators seeking an SEO-optimized platform with built-in features for AI agents and LLM discovery, leveraging React, Convex, and Vite for a dynamic, instantly updating user experience.

How It Works

This project utilizes a modern stack comprising React for the frontend, Vite for fast development builds, and Convex for real-time backend data synchronization. Content is authored in markdown files within the content/ directory. A sync script processes these files and uploads them to the Convex database, making them immediately available on the live site. Convex's real-time capabilities ensure that all connected browsers update automatically as content changes, eliminating the need for manual redeploys.

Quick Start & Requirements

• Prerequisites: Node.js 18 or higher, a Convex account.
• Installation: Run npm install.
• Convex Initialization: Execute npx convex dev to set up the Convex project and generate environment files.
• Development Server: Start the site with npm run dev.
• Further Information: Project repository available at github.com/waynesutton/markdown-site.

Highlighted Details

• SEO & Discovery: Features include RSS feeds (/rss.xml, /rss-full.xml), dynamic sitemaps (/sitemap.xml), JSON-LD structured data, Open Graph/Twitter Cards, and AI-specific robots.txt and llms.txt files.
• AI/LLM Integration: Provides API endpoints (/api/posts, /api/post?slug=xxx) for programmatic access to content and full-content RSS feeds optimized for LLM ingestion. Includes a "Copy Page" dropdown for sharing content to AI assistants like ChatGPT and Claude.
• Real-time Features: Leverages Convex for real-time data sync, enabling live updates across connected clients. Offers real-time analytics on a /stats page, tracking active visitors and page views without requiring manual refreshes.
• Search & Theming: Integrates full-text search via a Command+K shortcut, powered by Convex. Supports four distinct themes (Dark, Light, Tan, Cloud) with easy toggling.

Maintenance & Community

Specific details regarding maintenance, community engagement, or notable contributors are not detailed in the README.

Licensing & Compatibility

License information is not explicitly provided in the README. Compatibility for commercial use or closed-source linking would require clarification on the licensing terms.

Limitations & Caveats

The project relies heavily on the Convex platform for its real-time synchronization and backend functionality. Specific setup for production deployment, particularly with Netlify, requires careful configuration of environment variables and build commands as outlined in the documentation.