تعرف على Blume: إطار عمل توثيقي مفتوح المصدر وبدون تكوين يشحن مستندات جاهزة للذكاء الاصطناعي من مجلد Markdown

أصدر Hayden Bleasel، المطور الخبير في OpenAI بلوم، إطار توثيق مفتوح المصدر. تم شحن Blume إلى npm كإصدار 1.0.3 في نفس اليوم. الأمر بسيط مثل إسقاط Markdown في مجلد وشحن موقع المستندات. لا تتم كتابة أي نموذج معياري للتطبيق أو الاحتفاظ به بعد ذلك. المشروع مرخص من معهد ماساتشوستس للتكنولوجيا ومفتوح المصدر.

ما هو بلوم؟

بلوم هي أداة سطر أوامر مقترنة بمكتبة مكونات للمستندات. يقرأ مجلد ملفات Markdown أو MDX. ومن هذا المجلد، يتم إنشاء موقع توثيق على مستوى الإنتاج. يؤدي ذلك إلى إخراج صور التنقل والبحث والموضوعات وصور Open Graph. يبقى التكوين اختياريًا ويتم إضافته إلى ملف واحد في كل مرة. الكود هو TypeScript monorepo؛ الحزمة المنشورة تقع في packages/blume. وثائق بلوم الخاصة، تحت apps/docs، تم بناؤه باستخدام Blume نفسه. يتطلب Node.js 22.12 أو أحدث. يتم تشغيله باستخدام Bun أو pnpm أو npm أو الغزل.

كيف يعمل بلوم؟

تحت السطح، يقوم Blume بإنشاء مشروع Astro مخفي وقيادته. أولاً، يتم تحميل واجهة سطر الأوامر (CLI). blume.config.ts ويقوم بمسح المحتوى الخاص بك في رسم بياني. بعد ذلك، يقوم بكتابة مشروع Astro في ملف .blume/ دليل. يقوم Astro بعد ذلك بعرض كل صفحة من خلال مسار واحد شامل. يستورد هذا المسار مكونات Blume المشحونة والبيانات التي تم إنشاؤها وتجاوزاتك. في كل شوط، .blume/ يتجدد، وتتم إعادة كتابة الملفات التي تم تغييرها فقط. ونتيجة لذلك، تظل عملية إعادة التحميل السريع سريعة أثناء التحرير. الموضوع الأساسي لا يأتي مع إطار عمل العميل JavaScript. وبالتالي، تسجل الصفحات نتائج جيدة في Core Web Vitals بشكل افتراضي. عندما تحتاج إلى السيطرة الكاملة، blume eject يروج لوقت التشغيل في تطبيق Astro مستقل. لا يزال هذا المشروع الذي تم إخراجه يعتمد على blume طَرد.

ابدء

يتطلب الإعداد أمرًا واحدًا، لذا فإن عملية الإعداد تكون قصيرة.

بعد ذلك، blume dev يبدأ خادم إعادة التحميل السريع. في أثناء، blume build يكتب HTML ثابتًا وفهرس بحث محلي فيه dist/. ملف التكوين هو TypeScript حقيقي، وتم التحقق من صحته بواسطة مخطط.

// blume.config.ts
import { defineConfig } from "blume";

export default defineConfig({
  content: {
    sources: [
      { type: "filesystem", root: "docs" },
      { type: "notion", database: process.env.NOTION_DB },
    ],
  },
});

نظرًا لأن التكوين مكتوب، يكتشف المحررون الأخطاء قبل تشغيل البناء. تغطي واجهة سطر الأوامر (CLI) دورة الحياة الكاملة بما يتجاوز تلك الأساسيات:

AI-جاهز حسب التصميم

وبعيدًا عن القراء البشر، يستهدف بلوم العملاء أيضًا. تُرجع كل صفحة Markdown خامًا عند الإلحاق .md إلى عنوان URL الخاص به. ينبعث علم واحد llms.txt و llms-full.txt للوكلاء. يمكن نسخ كل صفحة كـ Markdown أو فتحها في ChatGPT أو Claude أو v0. يجيب مساعد Ask AI الاختياري الموجود في الصفحة على أسئلة القارئ مباشرة. يتم تشغيله على AI SDK من خلال Vercel AI Gateway أو OpenRouter أو Inkeep أو أي نقطة نهاية متوافقة مع OpenAI. يمكن لـ Blume أيضًا استضافة خادم بروتوكول السياق النموذجي (MCP). من خلاله، يقوم Claude Code وCursor وVS Code بقراءة المستندات مباشرة.

claude mcp add --transport http your-docs https://docs.example.com/mcp

يعرض هذا الخادم أربع أدوات للقراءة فقط: search_docs, get_page, list_pages، و get_navigation.

استخدام الحالات مع الأمثلة

وتحدد هذه القدرات وظائف ملموسة. بالنسبة لمنتج API، أدخل مواصفات OpenAPI أو AsyncAPI. يقوم Blume بعد ذلك بتقديم مرجع تفاعلي مع المخططات والمصادقة وملعب الطلب عبر Scalar. بالنسبة للمكتبة، قم بتوجيه Blume إلى إصدارات GitHub الخاصة بك. يتم عرض كل إصدار في مخطط زمني لسجل التغيير الذي تم إنشاؤه باستخدام موجز RSS. بالنسبة إلى الجمهور العالمي، أضف الملفات المترجمة لكل لغة. يدعم Blume 36 لغة محلية، وتوجيهًا مدركًا للغة، وتخطيطات من اليمين إلى اليسار. بالنسبة للمحتوى المختلط، قم بدمج الملفات المحلية مع MDX أو Notion أو Sanity البعيد. يتم تقديم جميع المصادر من خلال نفس المكونات.

كيف يقارن بلوم

للسياق، هنا بلوم ضد ثلاثة أساليب توثيق مشتركة. تتغير الميزات بسرعة، لذا تحقق من التفاصيل الحالية قبل اعتمادها.

نقاط القوة والضعف

نقاط القوة

• بداية التكوين الصفري: يصبح مجلد Markdown موقعًا كاملاً.
• لا يشحن الإخراج الثابت الأول أي عميل أساسي JS، مما يساعد Core Web Vitals.
• أسطح الذكاء الاصطناعي المدمجة: llms.txtوMarkdown لكل صفحة وخادم MCP وAsk AI.
• تكوين آمن للنوع، بحيث يقوم المحررون بالإبلاغ عن الأخطاء قبل تشغيل البناء.
• يؤدي إخراج المسار إلى تطبيق Astro المستقل إلى تقليل القفل على المدى الطويل.

نقاط الضعف

• الإصدار 1.0.3 جديد، وبالتالي فإن النظام البيئي لا يزال شابًا.
• فهو يحتاج إلى Node.js 22.12 أو أحدث، وهو ما تفتقر إليه بعض البيئات.
• تحتاج ميزات وقت الطلب مثل Ask AI وMCP إلى محول خادم.
• يعني النموذج المستضاف ذاتيًا أنك تمتلك التحليلات والأسلاك المساعدة.
• لديها عدد أقل من عمليات تكامل الجهات الخارجية مقارنة بالمنصات المستضافة الناضجة اليوم.

الوجبات السريعة الرئيسية

• يقوم Blume بتحويل مجلد Markdown إلى موقع مستندات إنتاج بدون تكوين.
• إنه يقود مشروع Astro وVite المخفي ويمكنه إخراجه إلى Astro المستقل.
• يتميز الذكاء الاصطناعي بالسفينة المضمنة: llms.txtوتخفيض السعر لكل صفحة وخادم MCP.
• إنه مرخص من MIT، ويحتاج إلى Node.js 22.12+، ووصل إلى npm v1.0.3 في يوم الإطلاق.
• من بين المتبنين الأوائل: Quiver، والانتقال من Mintlify، ومستندات Add-mcp الخاصة بـ Neon.

تحقق من جيثب الريبو. أيضا، لا تتردد في متابعتنا على تغريد ولا تنسى الانضمام إلينا 150 ألف + مل والاشتراك في النشرة الإخبارية لدينا. انتظر! هل أنت على برقية؟ الآن يمكنك الانضمام إلينا على التليجرام أيضًا.

هل تحتاج إلى الشراكة معنا للترويج لصفحة GitHub Repo أو صفحة الوجه المعانقة أو إصدار المنتج أو الندوة عبر الويب وما إلى ذلك؟ تواصل معنا