Product Introduction
- Definition: Blume 2.0 is a major version upgrade of Blume, a static site generator (SSG) and documentation framework built on modern web technologies. It is a zero-configuration, AI-ready platform designed to transform Markdown and MDX files into production-grade documentation websites.
- Core Value Proposition: Blume 2.0 exists to eliminate the traditional boilerplate and maintenance overhead of building developer documentation. Its primary value is enabling technical teams to ship a fast, searchable, and AI-assisted docs site by simply dropping content into a folder, dramatically reducing time-to-market and developer toil.
Main Features
- Adapter-Based Configuration: Blume 2.0 replaces string-based configuration with a modular adapter system. Key functionalities like search (Algolia, Typesense), deployment (Vercel, Netlify), content sourcing (GitHub, Notion), and AI assistants (OpenRouter, OpenAI) are now imported as functions from dedicated
blume/*subpaths (e.g.,blume/search,blume/deploy). This provides stronger TypeScript support, better code completion, and a more explicit, maintainable config structure. - AI-Powered Upgrade Assistant: The platform includes a dedicated
blume upgradecommand that automates migration from version 1.x. It performs dependency updates, scans configuration files for deprecated patterns, and provides line-by-line replacement instructions. It can also integrate with AI coding agents like Codex or Claude Code to apply changes interactively, ensuring a smooth, error-free major version transition. - Enhanced AI Assistant & Agent Framework: "Ask AI" is rebranded to the "assistant," with configuration moved from
ai.asktoai.assistant. More significantly, machine-readable agent settings (MCP servers, skill definitions, LLM configurations) are consolidated under a new top-levelagentskey. This separation clarifies the configuration between user-facing chat features and backend AI agent orchestration, preparing the docs for advanced AI tooling and automation. - Strict Build-Time Validation: Blume 2.0 introduces earlier and stricter validation. Custom component overrides in
components.tsare now checked at build time, preventing runtime errors. Inline component definitions are disallowed, enforcing better software architecture through explicit imports. The CLI also now fails on unrecognized command-line flags, improving script reliability and developer feedback.
Problems Solved
- Pain Point: Configuration Drift and Complexity. Traditional docs tools and earlier SSGs require extensive, fragile configuration files that intertwine content logic with deployment and service integrations, leading to upgrade friction and "snowflake" setups.
- Target Audience: Developer Advocates, Technical Writers, and Open-Source Maintainers who need to publish and maintain high-quality documentation without becoming full-stack web developers. It's also ideal for startup and product teams seeking a polished, feature-rich docs site from day one.
- Use Cases: Rapid MVP Documentation Launch for a new API or SDK; Migrating Legacy Documentation from a wiki or disparate sources into a unified, modern site; Adding AI-Powered Search and Q&A to existing technical content to improve developer support and self-service.
Unique Advantages
- Differentiation: Unlike heavier frameworks like Docusaurus or complex setups with Next.js and Tailwind, Blume 2.0 offers a true zero-configuration starting point with batteries-included features (search, analytics, API reference rendering). Compared to other "simple" SSGs (e.g., MkDocs), it provides deeper, native integrations for AI, real-time content sources, and modern deployment targets without plugin management hell.
- Key Innovation: The unified adapter architecture is its core innovation. By abstracting all external services and complex features into a consistent, importable adapter pattern, Blume 2.0 achieves a rare combination: extreme simplicity for basic use cases (just Markdown) and powerful, type-safe extensibility for advanced enterprise needs, all managed through a single, coherent configuration file.
Frequently Asked Questions (FAQ)
- Is the Blume 2.0 upgrade process automated? Yes, Blume 2.0 includes a dedicated CLI command (
npx blume@latest upgrade) that automatically bumps dependencies, analyzes your configuration, and provides a detailed report of required changes, significantly reducing manual migration effort and risk. - What happens to my existing Markdown content when upgrading to Blume 2.0? Your Markdown and MDX content remains completely untouched. Blume 2.0 is a configuration-only change. The upgrade focuses entirely on updating your
blume.config.tsandcomponents.tsfiles to the new adapter-based syntax, leaving all documentation pages intact. - Does Blume 2.0 still support API reference documentation from OpenAPI or GraphQL specs? Absolutely. API reference generation is enhanced in Blume 2.0, moving from separate top-level blocks (
openapi,graphql) to a unifiedreferencearray using adapters (e.g.,openapi(),graphql()). This provides a more consistent and flexible way to integrate multiple API specs into your documentation. - I have an ejected Blume 1 site. Can I upgrade it directly to Blume 2.0? No, direct upgrade of an ejected app is not recommended. The ejected code contains a snapshot of Blume 1's internal components. The advised path is to upgrade a fresh copy of your source project to Blume 2.0, then re-eject, and finally port your customizations over to the new ejected codebase.
