क्विकस्टार्ट

Blume इंस्टॉल करें, एक नया प्रोजेक्ट स्कैफ़ोल्ड करें, और मिनटों में अपना पहला डॉक्यूमेंटेशन पेज शिप करें — फिर अपनी गति से इसे एक पूरी साइट में विकसित करें।

कुछ ही कमांड में एक खाली फ़ोल्डर से चलती हुई डॉक्स साइट तक पहुँचें। Blume को Node.js 22.12 या नया और कम से कम एक .md या .mdx फ़ाइल वाले docs/ फ़ोल्डर की आवश्यकता होती है — सेट अप करने के लिए और कुछ नहीं है।

इंस्टॉल करें और चलाएँ

npm install blume

pnpm add blume

yarn add blume

bun add blume

blume init

docs/
  index.mdx
blume.config.ts

blume dev

blume build

अपना पहला पेज लिखें

हर पेज थोड़े फ़्रंटमैटर के साथ Markdown या MDX होता है — title और description स्वतः पेज हेडिंग और परिचय के रूप में रेंडर होते हैं। इसे docs/index.mdx में डालें:

---
title: Introduction
description: Welcome to my docs.
---

Welcome! Use **Markdown** and built-in components — no imports required:

:::note
Blume ships callouts, cards, tabs, steps, and more.
:::

इसे सेव करें, और डेव सर्वर तुरंत रीलोड हो जाता है। जैसे-जैसे आप फ़ाइलें जोड़ते हैं, नेविगेशन, सर्च, और पेज मेटाडेटा उनसे अनुमानित होते जाते हैं — लिखते रहें, और साइट साथ चलती रहेगी।

अगले कदम