# Blume > Open-source, markdown-first documentation powered by Astro and Vite. ## Changelog - [blume@1.4.2](https://useblume.dev/changelog/blume-1-4-2) - [blume@1.4.1](https://useblume.dev/changelog/blume-1-4-1) - [blume@1.4.0](https://useblume.dev/changelog/blume-1-4-0) - [blume@1.3.1](https://useblume.dev/changelog/blume-1-3-1) - [blume@1.3.0](https://useblume.dev/changelog/blume-1-3-0) - [blume@1.2.1](https://useblume.dev/changelog/blume-1-2-1) - [blume@1.2.0](https://useblume.dev/changelog/blume-1-2-0) - [blume@1.1.4](https://useblume.dev/changelog/blume-1-1-4) - [blume@1.1.3](https://useblume.dev/changelog/blume-1-1-3) - [blume@1.1.2](https://useblume.dev/changelog/blume-1-1-2) - [blume@1.1.1](https://useblume.dev/changelog/blume-1-1-1) - [blume@1.1.0](https://useblume.dev/changelog/blume-1-1-0) - [blume@1.0.4](https://useblume.dev/changelog/blume-1-0-4) - [blume@1.0.3](https://useblume.dev/changelog/blume-1-0-3) - [blume@1.0.2](https://useblume.dev/changelog/blume-1-0-2) - [blume@1.0.1](https://useblume.dev/changelog/blume-1-0-1) - [blume@1.0.0](https://useblume.dev/changelog/blume-1-0-0) ## Docs - [Introduction](https://useblume.dev/docs): Blume is an open-source, markdown-first documentation framework on Astro and Vite — fast, AI-ready, and zero-config down to the template. - [Quickstart](https://useblume.dev/docs/quickstart): Install Blume, scaffold a new project, and ship your first documentation page in minutes — then grow it into a full site at your own pace. - [Deployment](https://useblume.dev/docs/deployment): Deploy static docs to any host with zero configuration, or switch to server-side rendering with an adapter when you need dynamic behavior. - [FAQ](https://useblume.dev/docs/faq): Common questions about Blume — how it compares to other documentation tools, and why a Markdown formatter might collapse your callout directives. ### Content - [Pages](https://useblume.dev/docs/content): How the files in your content folder become pages, and how to organize and name them so routing and navigation are inferred automatically. - [Navigation](https://useblume.dev/docs/content/navigation): Blume builds the sidebar from your files, then lets you refine it with frontmatter, folder meta, or config — breadcrumbs and outlines follow along. - [Folder meta](https://useblume.dev/docs/content/meta): Configure a sidebar group with a meta.ts file beside its pages — set the group's title, icon, order, and the order of the pages nested inside. - [Syntax](https://useblume.dev/docs/content/syntax): Every Markdown and MDX feature Blume renders — formatting, lists, tables, callouts, code blocks, package installs, and math. - [Components](https://useblume.dev/docs/content/components): Cards, steps, tabs, accordions, badges, code groups, frames, trees, type tables, live previews, and diffs — the built-in components, usable in any MDX page. - [Islands](https://useblume.dev/docs/content/islands): Drop an interactive component into islands/ and use it in any MDX page — hydrated automatically, no per-page import. - [Content sources](https://useblume.dev/docs/content/sources): Pull docs from local files, a remote repository, or any custom backend — and mix several sources into one static-first site read at build time. - [Internationalization](https://useblume.dev/docs/content/i18n): Serve your docs in multiple languages with locale-aware routing, per-language navigation, translated UI, and SEO — all convention-first. ### Configuration - [Configuration file](https://useblume.dev/docs/configuration): Every option in blume.config.ts, from site metadata and content sources to the links that lead into each individual feature configuration guide. - [Theming](https://useblume.dev/docs/configuration/theming): Tune the look with a handful of config tokens, override any CSS variable in theme.css, or drop down to Tailwind utilities for custom components. - [Customization](https://useblume.dev/docs/configuration/customization): Override components, add interactive islands, mount custom pages, install registry components, or eject entirely when you need full control. - [Search](https://useblume.dev/docs/configuration/search): Client-side search that works out of the box with no API keys, plus optional hosted and semantic backends you can switch to as your docs grow. - [AI](https://useblume.dev/docs/configuration/ai): Make your docs machine-readable with llms.txt, add an optional in-page Ask AI assistant, and expose a hosted MCP server for coding agents. - [Analytics](https://useblume.dev/docs/configuration/analytics): First-party web analytics — Vercel Web Analytics, PostHog, or any custom script — wired up from blume.config.ts. - [Export](https://useblume.dev/docs/configuration/export): Let readers download any page as a PDF or EPUB — rendered client-side, so your static builds stay static and need no server infrastructure. - [SEO](https://useblume.dev/docs/configuration/seo): Metadata, Open Graph images, RSS feeds, and JSON-LD — Blume's discoverability layer, grouped under one seo config. ### Advanced - [Skills](https://useblume.dev/docs/advanced/skills): The agent skills Blume ships — playbooks that teach a coding agent like Claude Code, Codex, or Cursor to build and maintain a Blume docs site. - [Custom Pages](https://useblume.dev/docs/advanced/custom-pages): Mount fully custom .astro routes alongside your docs and read your site's config, navigation, and content from the blume:data module. - [Changelog](https://useblume.dev/docs/advanced/changelog): Author release notes as ordinary content files or source them from GitHub Releases, and Blume builds a timeline page and an RSS feed automatically. - [Blog](https://useblume.dev/docs/advanced/blog): Publish posts as content, get an RSS feed and article structured data for free, and build a custom index page. - [OpenAPI / AsyncAPI](https://useblume.dev/docs/advanced/api-reference): Drop in an OpenAPI spec and get a native API reference — one real page per operation, in your sidebar and search. ### Reference - [Frontmatter](https://useblume.dev/docs/reference/frontmatter): Every frontmatter field a page accepts, all optional — title, description, sidebar, SEO, search, and the rest, with what each one controls. - [CLI](https://useblume.dev/docs/reference/cli): Every Blume command and flag explained in one place — init, dev, build, preview, add, sync, and eject — along with the options each one accepts. - [Evals](https://useblume.dev/docs/reference/eval): blume eval gives your docs a test suite — an AI agent answers your users' questions using only the documentation, a judge grades the answers, and CI fails when the docs can't answer. - [Translate](https://useblume.dev/docs/reference/translate): blume translate fills in your locales with an AI agent — it finds the pages that are missing or outdated in each language, translates them with the agent CLI you already have, and gives CI a gate that fails when translations drift. ## Deutsch ### Docs - [Einführung](https://useblume.dev/de/docs): Blume ist ein quelloffenes, Markdown-zuerst-Dokumentationsframework auf Basis von Astro und Vite — schnell, KI-fähig und ohne Konfiguration bis hinunter zum Template. - [Schnellstart](https://useblume.dev/de/docs/quickstart): Installiere Blume, erstelle ein neues Projekt und veröffentliche deine erste Dokumentationsseite in wenigen Minuten – und baue sie in deinem eigenen Tempo zu einer vollständigen Website aus. - [Deployment](https://useblume.dev/de/docs/deployment): Statische Dokumentation ohne Konfiguration auf jedem Host bereitstellen oder bei Bedarf für dynamisches Verhalten mit einem Adapter auf serverseitiges Rendering umstellen. - [FAQ](https://useblume.dev/de/docs/faq): Häufige Fragen zu Blume — wie es sich im Vergleich zu anderen Dokumentationswerkzeugen schlägt und warum ein Markdown-Formatierer deine Callout-Direktiven zusammenfalten könnte. #### Inhalt - [Seiten](https://useblume.dev/de/docs/content): Wie die Dateien in deinem Content-Ordner zu Seiten werden und wie du sie organisierst und benennst, damit Routing und Navigation automatisch abgeleitet werden. - [Navigation](https://useblume.dev/de/docs/content/navigation): Blume erstellt die Seitenleiste aus deinen Dateien und lässt dich sie dann per Frontmatter, Ordner-Meta oder Konfiguration verfeinern – Breadcrumbs und Gliederungen folgen automatisch. - [Ordner-Meta](https://useblume.dev/de/docs/content/meta): Konfiguriere eine Sidebar-Gruppe mit einer meta.ts-Datei neben ihren Seiten — lege Titel, Icon und Reihenfolge der Gruppe sowie die Reihenfolge der darin verschachtelten Seiten fest. - [Syntax](https://useblume.dev/de/docs/content/syntax): Jede Markdown- und MDX-Funktion, die Blume rendert — Formatierung, Listen, Tabellen, Callouts, Codeblöcke, Paketinstallationen und Mathematik. - [Komponenten](https://useblume.dev/de/docs/content/components): Karten, Schritte, Tabs, Akkordeons, Badges, Codegruppen, Rahmen, Bäume, Typtabellen, Live-Vorschauen und Diffs – die integrierten Komponenten, nutzbar auf jeder MDX-Seite. - [Islands](https://useblume.dev/de/docs/content/islands): Lege eine interaktive Komponente in islands/ ab und nutze sie in jeder MDX-Seite — automatisch hydriert, ohne Import pro Seite. - [Inhaltsquellen](https://useblume.dev/de/docs/content/sources): Beziehe Dokumentation aus lokalen Dateien, einem entfernten Repository oder einem beliebigen eigenen Backend – und kombiniere mehrere Quellen zu einer static-first-Website, die zur Build-Zeit gelesen wird. - [Internationalisierung](https://useblume.dev/de/docs/content/i18n): Stelle deine Dokumentation in mehreren Sprachen bereit – mit locale-bewusstem Routing, sprachspezifischer Navigation, übersetzter Benutzeroberfläche und SEO – alles konventionsbasiert. #### Konfiguration - [Konfigurationsdatei](https://useblume.dev/de/docs/configuration): Jede Option in blume.config.ts, von Website-Metadaten und Inhaltsquellen bis zu den Links, die zu den einzelnen Konfigurationsanleitungen der jeweiligen Funktionen führen. - [Theming](https://useblume.dev/de/docs/configuration/theming): Passe das Erscheinungsbild mit einer Handvoll Konfigurations-Tokens an, überschreibe jede CSS-Variable in theme.css oder greife für eigene Komponenten auf Tailwind-Utilities zurück. - [Anpassung](https://useblume.dev/de/docs/configuration/customization): Überschreibe Komponenten, füge interaktive Islands hinzu, binde eigene Seiten ein, installiere Registry-Komponenten oder ejecte vollständig, wenn du volle Kontrolle brauchst. - [Suche](https://useblume.dev/de/docs/configuration/search): Clientseitige Suche, die ohne API-Schlüssel sofort funktioniert, plus optionale gehostete und semantische Backends, zu denen du wechseln kannst, wenn deine Doku wächst. - [KI](https://useblume.dev/de/docs/configuration/ai): Mach deine Dokumentation maschinenlesbar mit llms.txt, ergänze einen optionalen "Ask AI"-Assistenten direkt auf der Seite und stelle einen gehosteten MCP-Server für Coding-Agents bereit. - [Analytics](https://useblume.dev/de/docs/configuration/analytics): First-Party-Webanalyse — Vercel Web Analytics, PostHog oder ein beliebiges eigenes Skript — eingerichtet über blume.config.ts. - [Export](https://useblume.dev/de/docs/configuration/export): Lassen Sie Leser jede Seite als PDF oder EPUB herunterladen — clientseitig gerendert, damit Ihre statischen Builds statisch bleiben und keine Serverinfrastruktur benötigen. - [SEO](https://useblume.dev/de/docs/configuration/seo): Metadaten, Open-Graph-Bilder, RSS-Feeds und JSON-LD – die Auffindbarkeitsebene von Blume, gebündelt unter einer seo-Konfiguration. #### Erweitert - [Skills](https://useblume.dev/de/docs/advanced/skills): Die Agent Skills, die Blume mitliefert — Playbooks, die einem Coding-Agenten wie Claude Code, Codex oder Cursor beibringen, eine Blume-Dokumentationsseite zu erstellen und zu pflegen. - [Benutzerdefinierte Seiten](https://useblume.dev/de/docs/advanced/custom-pages): Binden Sie vollständig benutzerdefinierte .astro-Routen neben Ihrer Dokumentation ein und lesen Sie Konfiguration, Navigation und Inhalte Ihrer Website aus dem Modul blume:data. - [Changelog](https://useblume.dev/de/docs/advanced/changelog): Verfassen Sie Release Notes als gewöhnliche Inhaltsdateien oder beziehen Sie sie aus GitHub Releases – Blume erstellt daraus automatisch eine Timeline-Seite und einen RSS-Feed. - [Blog](https://useblume.dev/de/docs/advanced/blog): Veröffentliche Beiträge als Inhalte, erhalte kostenlos einen RSS-Feed und strukturierte Artikeldaten und erstelle eine eigene Übersichtsseite. - [OpenAPI / AsyncAPI](https://useblume.dev/de/docs/advanced/api-reference): Binde eine OpenAPI-Spezifikation ein und erhalte eine native API-Referenz – eine echte Seite pro Operation, in deiner Seitenleiste und Suche. #### Referenz - [Frontmatter](https://useblume.dev/de/docs/reference/frontmatter): Jedes Frontmatter-Feld, das eine Seite akzeptiert, alle optional — Titel, Beschreibung, Sidebar, SEO, Suche und alles Weitere, mit der jeweiligen Funktion. - [CLI](https://useblume.dev/de/docs/reference/cli): Jeder Blume-Befehl und jedes Flag an einem Ort erklärt — init, dev, build, preview, add, sync und eject — zusammen mit den Optionen, die jeder davon akzeptiert. - [Evals](https://useblume.dev/de/docs/reference/eval): blume eval verleiht deiner Dokumentation eine Testsuite – ein KI-Agent beantwortet die Fragen deiner Nutzer allein anhand der Dokumentation, ein Judge bewertet die Antworten, und die CI schlägt fehl, wenn die Dokumentation keine Antwort liefert. - [Übersetzen](https://useblume.dev/de/docs/reference/translate): blume translate füllt deine Locales mit einem KI-Agenten – es findet die Seiten, die in jeder Sprache fehlen oder veraltet sind, übersetzt sie mit der Agent-CLI, die du bereits hast, und gibt CI eine Schranke, die fehlschlägt, wenn Übersetzungen abdriften. ## हिन्दी ### Docs - [परिचय](https://useblume.dev/hi/docs): Blume एक ओपन-सोर्स, मार्कडाउन-फर्स्ट डॉक्यूमेंटेशन फ्रेमवर्क है जो Astro और Vite पर आधारित है — तेज़, AI-तैयार, और टेम्पलेट तक शून्य-कॉन्फ़िग। - [क्विकस्टार्ट](https://useblume.dev/hi/docs/quickstart): Blume इंस्टॉल करें, एक नया प्रोजेक्ट स्कैफ़ोल्ड करें, और मिनटों में अपना पहला डॉक्यूमेंटेशन पेज शिप करें — फिर अपनी गति से इसे एक पूरी साइट में विकसित करें। - [परिनियोजन](https://useblume.dev/hi/docs/deployment): शून्य कॉन्फ़िगरेशन के साथ स्टैटिक डॉक्स को किसी भी होस्ट पर परिनियोजित करें, या जब आपको डायनामिक व्यवहार की आवश्यकता हो तो एडाप्टर के साथ सर्वर-साइड रेंडरिंग पर स्विच करें। - [सामान्य प्रश्न (FAQ)](https://useblume.dev/hi/docs/faq): Blume के बारे में सामान्य प्रश्न — यह अन्य डॉक्यूमेंटेशन टूल्स से कैसे भिन्न है, और Markdown फ़ॉर्मैटर आपके callout डायरेक्टिव्स को क्यों समेट सकता है। #### सामग्री - [पेज](https://useblume.dev/hi/docs/content): आपके कंटेंट फ़ोल्डर की फ़ाइलें कैसे पेज बनती हैं, और उन्हें कैसे व्यवस्थित तथा नामित करें ताकि रूटिंग और नेविगेशन अपने आप अनुमानित हो जाएँ। - [नेविगेशन](https://useblume.dev/hi/docs/content/navigation): Blume आपकी फ़ाइलों से साइडबार बनाता है, फिर आपको फ्रंटमैटर, फ़ोल्डर मेटा, या कॉन्फ़िग से उसे परिष्कृत करने देता है — ब्रेडक्रंब और आउटलाइन साथ-साथ चलते हैं। - [फ़ोल्डर मेटा](https://useblume.dev/hi/docs/content/meta): अपने पेजों के साथ एक meta.ts फ़ाइल रखकर साइडबार समूह कॉन्फ़िगर करें — समूह का शीर्षक, आइकन, क्रम, और उसमें नेस्टेड पेजों का क्रम सेट करें। - [सिंटैक्स](https://useblume.dev/hi/docs/content/syntax): हर Markdown और MDX फ़ीचर जिसे Blume रेंडर करता है — फ़ॉर्मेटिंग, सूचियाँ, टेबल, कॉलआउट, कोड ब्लॉक, पैकेज इंस्टॉल, और गणित। - [घटक](https://useblume.dev/hi/docs/content/components): कार्ड, स्टेप्स, टैब, अकॉर्डियन, बैज, कोड ग्रुप, फ़्रेम, ट्री, टाइप टेबल, लाइव प्रीव्यू और डिफ़ — अंतर्निहित घटक, जो किसी भी MDX पेज में उपयोग किए जा सकते हैं। - [आइलैंड्स](https://useblume.dev/hi/docs/content/islands): किसी इंटरैक्टिव कंपोनेंट को islands/ में रखें और उसे किसी भी MDX पेज में इस्तेमाल करें — स्वचालित रूप से हाइड्रेट, हर पेज पर इंपोर्ट किए बिना। - [कंटेंट स्रोत](https://useblume.dev/hi/docs/content/sources): लोकल फ़ाइलों, किसी रिमोट रिपॉज़िटरी, या किसी भी कस्टम बैकएंड से डॉक्स लाएँ — और कई स्रोतों को एक ऐसी स्टैटिक-फ़र्स्ट साइट में मिलाएँ जो बिल्ड टाइम पर पढ़ी जाती है। - [अंतर्राष्ट्रीयकरण](https://useblume.dev/hi/docs/content/i18n): लोकेल-अवेयर रूटिंग, प्रति-भाषा नेविगेशन, अनूदित UI और SEO के साथ अपने डॉक्स को कई भाषाओं में परोसें — सब कुछ कन्वेंशन-फ़र्स्ट। #### कॉन्फ़िगरेशन - [कॉन्फ़िगरेशन फ़ाइल](https://useblume.dev/hi/docs/configuration): blume.config.ts का हर विकल्प — साइट मेटाडेटा और कंटेंट स्रोतों से लेकर उन लिंक्स तक जो हर अलग-अलग फ़ीचर कॉन्फ़िगरेशन गाइड तक ले जाते हैं। - [थीमिंग](https://useblume.dev/hi/docs/configuration/theming): कुछ ही कॉन्फ़िग टोकन के साथ लुक ट्यून करें, theme.css में किसी भी CSS वेरिएबल को ओवरराइड करें, या कस्टम कंपोनेंट्स के लिए Tailwind यूटिलिटीज़ तक उतरें। - [कस्टमाइज़ेशन](https://useblume.dev/hi/docs/configuration/customization): कंपोनेंट्स को ओवरराइड करें, इंटरैक्टिव आइलैंड्स जोड़ें, कस्टम पेज माउंट करें, रजिस्ट्री कंपोनेंट्स इंस्टॉल करें, या जब आपको पूरा नियंत्रण चाहिए तो पूरी तरह इजेक्ट कर दें। - [खोज](https://useblume.dev/hi/docs/configuration/search): क्लाइंट-साइड खोज जो बिना किसी API keys के तुरंत काम करती है, साथ ही वैकल्पिक होस्टेड और सिमेंटिक बैकएंड जिन पर आप अपने docs के बढ़ने के साथ स्विच कर सकते हैं। - [AI](https://useblume.dev/hi/docs/configuration/ai): llms.txt के साथ अपने डॉक्स को मशीन-पठनीय बनाएँ, एक वैकल्पिक इन-पेज Ask AI सहायक जोड़ें, और कोडिंग एजेंट्स के लिए एक होस्टेड MCP सर्वर उपलब्ध कराएँ। - [एनालिटिक्स](https://useblume.dev/hi/docs/configuration/analytics): फ़र्स्ट-पार्टी वेब एनालिटिक्स — Vercel Web Analytics, PostHog, या कोई भी कस्टम स्क्रिप्ट — blume.config.ts से जुड़ी हुई। - [निर्यात](https://useblume.dev/hi/docs/configuration/export): पाठकों को किसी भी पेज को PDF या EPUB के रूप में डाउनलोड करने दें — क्लाइंट-साइड पर रेंडर किया गया, ताकि आपके स्टैटिक बिल्ड स्टैटिक ही रहें और किसी सर्वर इंफ़्रास्ट्रक्चर की ज़रूरत न पड़े। - [SEO](https://useblume.dev/hi/docs/configuration/seo): मेटाडेटा, Open Graph छवियाँ, RSS फ़ीड और JSON-LD — Blume की खोज-योग्यता परत, एक ही seo कॉन्फ़िग के अंतर्गत समूहीकृत। #### उन्नत - [स्किल्स](https://useblume.dev/hi/docs/advanced/skills): Blume के साथ आने वाली एजेंट स्किल्स — ऐसे प्लेबुक जो Claude Code, Codex या Cursor जैसे कोडिंग एजेंट को Blume डॉक्स साइट बनाना और उसका रखरखाव करना सिखाते हैं। - [कस्टम पेज](https://useblume.dev/hi/docs/advanced/custom-pages): पूरी तरह कस्टम .astro रूट्स को अपने डॉक्स के साथ माउंट करें और अपनी साइट का कॉन्फ़िग, नेविगेशन तथा कंटेंट blume:data मॉड्यूल से पढ़ें। - [चेंजलॉग](https://useblume.dev/hi/docs/advanced/changelog): रिलीज़ नोट्स को सामान्य कंटेंट फ़ाइलों के रूप में लिखें या उन्हें GitHub Releases से लें, और Blume अपने आप एक टाइमलाइन पेज और एक RSS फ़ीड बना देता है। - [ब्लॉग](https://useblume.dev/hi/docs/advanced/blog): पोस्ट को कंटेंट के रूप में प्रकाशित करें, मुफ़्त में RSS फ़ीड और आर्टिकल स्ट्रक्चर्ड डेटा पाएँ, और एक कस्टम इंडेक्स पेज बनाएँ। - [OpenAPI / AsyncAPI](https://useblume.dev/hi/docs/advanced/api-reference): एक OpenAPI स्पेक जोड़ें और एक नेटिव API संदर्भ पाएँ — प्रति ऑपरेशन एक वास्तविक पृष्ठ, आपके साइडबार और खोज में। #### संदर्भ - [फ्रंटमैटर](https://useblume.dev/hi/docs/reference/frontmatter): हर वह फ्रंटमैटर फ़ील्ड जो कोई पृष्ठ स्वीकार करता है, सभी वैकल्पिक — title, description, sidebar, SEO, search, और बाक़ी सब, साथ में यह कि हर एक क्या नियंत्रित करता है। - [CLI](https://useblume.dev/hi/docs/reference/cli): Blume का हर कमांड और फ़्लैग एक ही जगह समझाया गया — init, dev, build, preview, add, sync, और eject — साथ ही हर एक द्वारा स्वीकार किए जाने वाले विकल्प भी। - [मूल्यांकन (Evals)](https://useblume.dev/hi/docs/reference/eval): blume eval आपके डॉक्स को एक टेस्ट सूट देता है — एक AI एजेंट केवल दस्तावेज़ों का उपयोग करके आपके उपयोगकर्ताओं के प्रश्नों के उत्तर देता है, एक जज उन उत्तरों को अंक देता है, और जब डॉक्स उत्तर नहीं दे पाते तो CI विफल हो जाता है। - [अनुवाद](https://useblume.dev/hi/docs/reference/translate): blume translate आपके लोकेल्स को एक AI एजेंट की मदद से भरता है — यह पता लगाता है कि हर भाषा में कौन-से पेज गायब या पुराने हैं, उन्हें उसी एजेंट CLI से अनुवाद करता है जो आपके पास पहले से है, और CI को एक ऐसा गेट देता है जो अनुवाद के पिछड़ जाने पर फेल हो जाता है। ## 日本語 ### Docs - [はじめに](https://useblume.dev/ja/docs): Blume は Astro と Vite 上に構築された、オープンソースかつ Markdown ファーストのドキュメントフレームワークです。高速で、AI に対応し、テンプレートに至るまでゼロコンフィグです。 - [クイックスタート](https://useblume.dev/ja/docs/quickstart): Blume をインストールし、新しいプロジェクトを作成して、数分で最初のドキュメントページを公開しましょう。その後は自分のペースで本格的なサイトへと育てていけます。 - [デプロイ](https://useblume.dev/ja/docs/deployment): 設定不要で静的ドキュメントを任意のホストにデプロイできます。動的な挙動が必要な場合は、アダプターを使ってサーバーサイドレンダリングに切り替えられます。 - [FAQ](https://useblume.dev/ja/docs/faq): Blume に関するよくある質問 — 他のドキュメントツールとの比較、そして Markdown フォーマッタがコールアウトディレクティブを潰してしまう理由。 #### コンテンツ - [ページ](https://useblume.dev/ja/docs/content): content フォルダー内のファイルがどのようにページになるのか、そしてルーティングとナビゲーションが自動的に推論されるようにファイルを整理・命名する方法。 - [ナビゲーション](https://useblume.dev/ja/docs/content/navigation): Blume はファイルからサイドバーを構築し、フロントマター、フォルダーの meta、または設定で調整できるようにします — パンくずリストとアウトラインもそれに追従します。 - [フォルダーメタ](https://useblume.dev/ja/docs/content/meta): ページと同じ階層に meta.ts ファイルを置いてサイドバーグループを設定します — グループのタイトル、アイコン、順序、および内部にネストされたページの順序を設定できます。 - [構文](https://useblume.dev/ja/docs/content/syntax): Blume がレンダリングする Markdown と MDX の全機能 — 書式設定、リスト、テーブル、コールアウト、コードブロック、パッケージインストール、数式。 - [コンポーネント](https://useblume.dev/ja/docs/content/components): カード、ステップ、タブ、アコーディオン、バッジ、コードグループ、フレーム、ツリー、型テーブル、ライブプレビュー、差分 — 任意の MDX ページで使える組み込みコンポーネント。 - [アイランド](https://useblume.dev/ja/docs/content/islands): interactive なコンポーネントを islands/ に置くだけで、任意の MDX ページで使えます — 自動的にハイドレートされ、ページごとの import は不要です。 - [コンテンツソース](https://useblume.dev/ja/docs/content/sources): ローカルファイル、リモートリポジトリ、または任意のカスタムバックエンドからドキュメントを取得し、複数のソースをビルド時に読み込む1つのスタティックファーストなサイトに統合できます。 - [国際化](https://useblume.dev/ja/docs/content/i18n): ロケール対応のルーティング、言語ごとのナビゲーション、翻訳された UI、SEO を備え、複数の言語でドキュメントを配信できます — すべて規約優先で。 #### 設定 - [設定ファイル](https://useblume.dev/ja/docs/configuration): サイトのメタデータやコンテンツソースから、各機能の設定ガイドへのリンクまで、blume.config.ts のすべてのオプション。 - [テーマ設定](https://useblume.dev/ja/docs/configuration/theming): いくつかの設定トークンで見た目を調整したり、theme.css で任意の CSS 変数を上書きしたり、カスタムコンポーネント向けに Tailwind ユーティリティまで踏み込んだりできます。 - [カスタマイズ](https://useblume.dev/ja/docs/configuration/customization): コンポーネントの上書き、インタラクティブなアイランドの追加、カスタムページのマウント、レジストリコンポーネントのインストール、または完全な制御が必要な場合の完全なイジェクト。 - [検索](https://useblume.dev/ja/docs/configuration/search): APIキー不要ですぐに使えるクライアントサイド検索。ドキュメントの成長に合わせて切り替えられる、ホスト型やセマンティック検索のバックエンドもオプションで利用できます。 - [AI](https://useblume.dev/ja/docs/configuration/ai): llms.txt でドキュメントを機械可読にし、ページ内の Ask AI アシスタント(任意)を追加し、コーディングエージェント向けにホスト型 MCP サーバーを公開します。 - [アナリティクス](https://useblume.dev/ja/docs/configuration/analytics): ファーストパーティのウェブアナリティクス — Vercel Web Analytics、PostHog、または任意のカスタムスクリプト — を blume.config.ts から設定できます。 - [エクスポート](https://useblume.dev/ja/docs/configuration/export): 任意のページを PDF または EPUB として読者にダウンロードしてもらえます。クライアントサイドでレンダリングされるため、静的ビルドは静的なままで、サーバーインフラは不要です。 - [SEO](https://useblume.dev/ja/docs/configuration/seo): メタデータ、Open Graph 画像、RSS フィード、JSON-LD — Blume の発見性レイヤーを 1 つの seo 設定にまとめました。 #### 高度な設定 - [スキル](https://useblume.dev/ja/docs/advanced/skills): Blume が提供するエージェントスキル — Claude Code、Codex、Cursor などのコーディングエージェントに Blume ドキュメントサイトの構築と保守を教えるプレイブックです。 - [カスタムページ](https://useblume.dev/ja/docs/advanced/custom-pages): 完全にカスタムな .astro ルートをドキュメントと並べてマウントし、サイトの設定、ナビゲーション、コンテンツを blume:data モジュールから読み取ります。 - [変更履歴](https://useblume.dev/ja/docs/advanced/changelog): リリースノートを通常のコンテンツファイルとして書くか、GitHub Releases から取得すると、Blume がタイムラインページと RSS フィードを自動的に構築します。 - [ブログ](https://useblume.dev/ja/docs/advanced/blog): 投稿をコンテンツとして公開し、RSS フィードと記事の構造化データを無料で取得して、独自のインデックスページを構築できます。 - [OpenAPI / AsyncAPI](https://useblume.dev/ja/docs/advanced/api-reference): OpenAPI 仕様を投入するだけでネイティブな API リファレンスを生成 — 操作ごとに 1 つの実ページを、サイドバーと検索に。 #### リファレンス - [フロントマター](https://useblume.dev/ja/docs/reference/frontmatter): ページが受け付けるフロントマターフィールドをすべて解説します。すべて任意項目で、title、description、sidebar、SEO、search などが何を制御するのかをまとめています。 - [CLI](https://useblume.dev/ja/docs/reference/cli): Blume のすべてのコマンドとフラグを一箇所で解説します — init、dev、build、preview、add、sync、eject と、それぞれが受け付けるオプション。 - [評価(Evals)](https://useblume.dev/ja/docs/reference/eval): blume eval はドキュメントにテストスイートを与えます。AI エージェントがドキュメントだけを使ってユーザーの質問に答え、ジャッジがその回答を採点し、ドキュメントが答えられない場合は CI が失敗します。 - [翻訳](https://useblume.dev/ja/docs/reference/translate): blume translate は AI エージェントを使ってロケールを埋めていきます。各言語で不足している、あるいは古くなったページを検出し、すでに手元にあるエージェント CLI で翻訳し、翻訳がずれたときに失敗する CI ゲートを提供します。 ## Português ### Docs - [Introdução](https://useblume.dev/pt/docs): Blume é um framework de documentação open-source, markdown-first, baseado em Astro e Vite — rápido, pronto para IA e zero-config até o template. - [Início rápido](https://useblume.dev/pt/docs/quickstart): Instale o Blume, crie a estrutura de um novo projeto e publique a sua primeira página de documentação em minutos — depois faça-a crescer até um site completo ao seu próprio ritmo. - [Implantação](https://useblume.dev/pt/docs/deployment): Implante documentação estática em qualquer host sem configuração alguma, ou mude para renderização no servidor com um adaptador quando precisar de comportamento dinâmico. - [FAQ](https://useblume.dev/pt/docs/faq): Perguntas comuns sobre o Blume — como ele se compara a outras ferramentas de documentação e por que um formatador de Markdown pode colapsar as suas diretivas de callout. #### Conteúdo - [Páginas](https://useblume.dev/pt/docs/content): Como os ficheiros na sua pasta de conteúdo se tornam páginas, e como organizá-los e nomeá-los para que o encaminhamento e a navegação sejam inferidos automaticamente. - [Navegação](https://useblume.dev/pt/docs/content/navigation): O Blume monta a barra lateral a partir dos seus arquivos e depois permite refiná-la com frontmatter, meta de pasta ou configuração — trilhas de navegação e sumários acompanham automaticamente. - [Meta de pasta](https://useblume.dev/pt/docs/content/meta): Configure um grupo da barra lateral com um arquivo meta.ts junto às suas páginas — defina o título, o ícone e a ordem do grupo, além da ordem das páginas aninhadas dentro dele. - [Sintaxe](https://useblume.dev/pt/docs/content/syntax): Todos os recursos de Markdown e MDX que o Blume renderiza — formatação, listas, tabelas, avisos, blocos de código, instalação de pacotes e matemática. - [Componentes](https://useblume.dev/pt/docs/content/components): Cards, steps, tabs, accordions, badges, grupos de código, frames, árvores, tabelas de tipos, prévias ao vivo e diffs — os componentes integrados, utilizáveis em qualquer página MDX. - [Ilhas](https://useblume.dev/pt/docs/content/islands): Coloque um componente interativo em islands/ e use-o em qualquer página MDX — hidratado automaticamente, sem importação por página. - [Fontes de conteúdo](https://useblume.dev/pt/docs/content/sources): Traga documentação de arquivos locais, de um repositório remoto ou de qualquer backend personalizado — e combine várias fontes em um único site static-first lido em tempo de build. - [Internacionalização](https://useblume.dev/pt/docs/content/i18n): Sirva sua documentação em vários idiomas com roteamento sensível ao locale, navegação por idioma, interface traduzida e SEO — tudo baseado em convenções. #### Configuração - [Ficheiro de configuração](https://useblume.dev/pt/docs/configuration): Todas as opções em blume.config.ts, desde os metadados do site e as fontes de conteúdo até às ligações que conduzem a cada guia de configuração de funcionalidade. - [Temas](https://useblume.dev/pt/docs/configuration/theming): Ajuste a aparência com alguns tokens de configuração, sobrescreva qualquer variável CSS em theme.css ou recorra aos utilitários do Tailwind para componentes personalizados. - [Personalização](https://useblume.dev/pt/docs/configuration/customization): Substitua componentes, adicione ilhas interativas, monte páginas personalizadas, instale componentes do registro ou faça eject completo quando precisar de controle total. - [Busca](https://useblume.dev/pt/docs/configuration/search): Busca do lado do cliente que funciona imediatamente, sem chaves de API, além de backends hospedados e semânticos opcionais para os quais você pode migrar conforme sua documentação cresce. - [IA](https://useblume.dev/pt/docs/configuration/ai): Torne sua documentação legível por máquinas com llms.txt, adicione um assistente Ask AI opcional na página e exponha um servidor MCP hospedado para agentes de programação. - [Analytics](https://useblume.dev/pt/docs/configuration/analytics): Análises web de origem própria — Vercel Web Analytics, PostHog ou qualquer script personalizado — configuradas a partir do blume.config.ts. - [Exportar](https://useblume.dev/pt/docs/configuration/export): Permita que os leitores baixem qualquer página como PDF ou EPUB — renderizado no lado do cliente, para que suas builds estáticas continuem estáticas e não precisem de infraestrutura de servidor. - [SEO](https://useblume.dev/pt/docs/configuration/seo): Metadados, imagens Open Graph, feeds RSS e JSON-LD — a camada de descoberta do Blume, agrupada sob uma única configuração seo. #### Avançado - [Skills](https://useblume.dev/pt/docs/advanced/skills): As skills de agente que o Blume oferece — playbooks que ensinam um agente de programação como Claude Code, Codex ou Cursor a construir e manter um site de documentação Blume. - [Páginas Personalizadas](https://useblume.dev/pt/docs/advanced/custom-pages): Monte rotas .astro totalmente personalizadas ao lado da sua documentação e leia a configuração, a navegação e o conteúdo do seu site a partir do módulo blume:data. - [Changelog](https://useblume.dev/pt/docs/advanced/changelog): Escreva as notas de lançamento como ficheiros de conteúdo normais ou obtenha-as do GitHub Releases, e o Blume constrói automaticamente uma página de cronologia e um feed RSS. - [Blog](https://useblume.dev/pt/docs/advanced/blog): Publique posts como conteúdo, obtenha um feed RSS e dados estruturados de artigo gratuitamente, e crie uma página de índice personalizada. - [OpenAPI / AsyncAPI](https://useblume.dev/pt/docs/advanced/api-reference): Adicione uma especificação OpenAPI e obtenha uma referência de API nativa — uma página real por operação, na sua barra lateral e na busca. #### Referência - [Frontmatter](https://useblume.dev/pt/docs/reference/frontmatter): Todos os campos de frontmatter que uma página aceita, todos opcionais — título, descrição, barra lateral, SEO, pesquisa e os demais, com o que cada um controla. - [CLI](https://useblume.dev/pt/docs/reference/cli): Todos os comandos e flags do Blume explicados num só lugar — init, dev, build, preview, add, sync e eject — juntamente com as opções que cada um aceita. - [Avaliações](https://useblume.dev/pt/docs/reference/eval): O blume eval dá à sua documentação um conjunto de testes — um agente de IA responde às perguntas dos seus usuários usando apenas a documentação, um juiz avalia as respostas e a CI falha quando a documentação não consegue responder. - [Traduzir](https://useblume.dev/pt/docs/reference/translate): O blume translate preenche seus locales com um agente de IA — ele encontra as páginas que estão faltando ou desatualizadas em cada idioma, as traduz com a CLI de agente que você já tem e dá ao CI um portão que falha quando as traduções ficam dessincronizadas. ## RSS Feeds - [Blume — Changelog](https://useblume.dev/changelog/rss.xml)