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

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

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

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

प्रोजेक्ट बनाएँ

blume init कुछ सवाल पूछता है — प्रोजेक्ट कहाँ बनाना है, आपकी डॉक्स साइट का नाम क्या है, कौन सा टेम्पलेट, और आपका कंटेंट कहाँ रहता है — फिर न्यूनतम सतह स्कैफ़ोल्ड करता है: एक कंटेंट फ़ोल्डर, एक कॉन्फ़िग फ़ाइल, और dev, build, तथा doctor स्क्रिप्ट्स वाली एक package.json, साथ ही एक .gitignore जो node_modules/, जनरेट किए गए .blume/, dist/, और .env.local (जहाँ लोकल सीक्रेट्स रखे जाते हैं) को वर्ज़न कंट्रोल से बाहर रखती है। यह डिपेंडेंसीज़ को उसी पैकेज मैनेजर से इंस्टॉल करता है जिससे इसे चलाया गया था। प्रॉम्प्ट छोड़ने और डिफ़ॉल्ट अपनाने के लिए --yes पास करें, या केवल फ़ाइलें लिखने के लिए --no-install पास करें।

npx blume init

pnpm dlx blume init

yarn dlx blume init

bunx blume init

nubx blume init

aube dlx blume init

pnpm 12 पर, pnpm dlx के बाद --allow-build=esbuild जोड़ें (pnpm dlx --allow-build=esbuild blume init): pnpm 12 esbuild की इंस्टॉल स्क्रिप्ट, जिस पर Astro निर्भर है, तब तक नहीं चलाता जब तक आप उसे स्वीकृति न दें। किसी मौजूदा pnpm वर्कस्पेस के भीतर, नए फ़ोल्डर को वर्कस्पेस के packages के अंतर्गत सूचीबद्ध होना चाहिए (pnpm इसके अलावा कुछ भी इंस्टॉल नहीं करता, इसलिए जब तक ऐसा न हो, init इंस्टॉल को छोड़ देता है), और esbuild के लिए वर्कस्पेस की pnpm-workspace.yaml में allowBuilds: { esbuild: true } आवश्यक है; init आपको इन दोनों की याद दिलाता है। Yarn 2 या उसके बाद के संस्करण के साथ, init एक .yarnrc.yml लिखता है जो Yarn को node_modules इंस्टॉल पर स्विच कर देता है, जिसकी Blume को आवश्यकता होती है; Yarn 1 पर, npx blume init चलाएँ।

docs/
  index.mdx
.gitignore
blume.config.ts
package.json

डेव सर्वर शुरू करें

प्रोजेक्ट डायरेक्टरी से, Blume रनटाइम जनरेट करता है और आपके डॉक्स को हॉट रीलोड के साथ सर्व करता है।

npm run dev

pnpm run dev

yarn run dev

bun run dev

nub run dev

aube run dev

प्रोडक्शन के लिए बिल्ड करें

स्टैटिक HTML dist/ में लिखा जाता है, और उसके ऊपर एक लोकल सर्च इंडेक्स बनाया जाता है।

npm run build

pnpm run build

yarn run build

bun run build

nub run build

aube run build

क्या आप Blume को ऐसे प्रोजेक्ट में जोड़ रहे हैं जिसमें पहले से एक package.json है? blume init मौजूदा फ़ाइलों को नहीं छेड़ता और इंस्टॉल को छोड़ देता है, इसलिए Blume को खुद इंस्टॉल करें (npm install blume), फिर उसकी स्क्रिप्ट्स में "dev": "blume dev" और "build": "blume build" जोड़ें, या सीधे npx blume dev चलाएँ। init जो अगले कदम प्रिंट करता है, उनमें आपके पैकेज मैनेजर के लिए ये दोनों कमांड शामिल होते हैं।

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

हर पेज थोड़े फ़्रंटमैटर के साथ 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.
:::

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

अगले कदम

कॉन्फ़िगरेशन

टाइटल, थीम, सर्च, और डिप्लॉयमेंट को ट्यून करें।

कंपोनेंट्स

बिल्ट-इन कंपोनेंट लाइब्रेरी को एक्सप्लोर करें।

डिस्कवरेबिलिटी

llms.txt, सोशल कार्ड्स, और एक MCP सर्वर शिप करें।

डिप्लॉयमेंट

किसी भी स्टैटिक होस्ट पर लाइव जाएँ।