عن المشروع
Edda هي أداة سطر أوامر لبناء ونشر مواقع التوثيق المكتوبة بصيغة MDX، وتُقدَّم على أنها "مستندات معرفية للوكلاء" مع سير عمل أصلي في git ينشر عند الدمج. يقدّم ملف README هذه الأداة على أنها النهج نفسه المستخدم لكل موقع توثيق على منصتها، بما في ذلك captain.blode.md.
التثبيت عالمي عبر npm: `npm install -g edda-docs`. تدفق البدء السريع هو: `edda login` للمصادقة مع GitHub في المتصفح (دون الحاجة إلى إدارة مفتاح API يدويًا)، و`edda new docs --template starter` لإنشاء هيكل موقع توثيق في دليل، و`edda dev` لخدمته محليًا على localhost:3030 مع إعادة التحميل عند التعديل، و`edda push docs` للنشر. يصبح الموقع المنشور متاحًا على نطاق فرعي خاص به ضمن blode.md، مع أخذ الاسم والتنقل والسمة من ملف docs.json الذي ينشئه `edda new`.
تشمل مجموعة الأوامر المصادقة (`login`)، وإنشاء الهيكل (`new`، مع قوالب `minimal` أو `starter`)، والمعاينة المحلية (`dev`)، وفحص الإعدادات (`validate`)، والنشر (`push`)، وسرد الحسابات (`projects`)، وإدارة تحليلات PostHog (`analytics` مع `get` و`set posthog <key>` و`unset posthog`).
لاستخدام الوكلاء، يوثّق ملف README أمرًا مائلًا قابلًا للتثبيت لـ Claude Code أو أي وكيل متوافق مع skills.sh عبر `npx skills add mblode/edda -g --all -y`، وبعد ذلك يمكن تشغيل إنشاء الهيكل والنشر بلغة طبيعية، مثل `/edda new my-project --template starter` و`/edda push docs/ --project my-project`.
يحظى دعم CI والأتمتة بتركيز ملحوظ. تشمل متغيرات البيئة EDDA_API_KEY / BLODEMD_API_KEY (تُستخدم قبل جلسة تسجيل الدخول المخزنة حتى لا يحتاج CI إلى تسجيل دخول تفاعلي)، وEDDA_PROJECT / BLODEMD_PROJECT كقيمة افتراضية لـ `--project`، وEDDA_API_URL / BLODEMD_API_URL لأصل API. تُوثَّق أكواد الخروج على أنها ثابتة وقابلة للتفرع: 0 نجاح، 1 خطأ، 2 ملغى (بما في ذلك رفض مطالبة)، 3 إدخال أو إعدادات غير صالحة، 4 مصادقة مطلوبة، 5 فشل الشبكة. مع `--json`، تُصدَر حالات الفشل كسطر واحد على stdout بالشكل `{"error":true,"code":"AUTH_REQUIRED","message":"...","hint":"..."}`، وينصح ملف README بالتفرع بناءً على حقل `code` الثابت بدلًا من `message` الموجه للبشر.
تشير ملاحظات إضافية إلى أن Node.js 24 مطلوب، وأن `push` و`validate` و`projects` تقبل `--json`، وأن `push` تقرأ قيم المشروع ومفتاح API والفرع من البيئة للنشر غير التفاعلي في CI، وأن تثبيت تطبيق GitHub من لوحة تحكم المشروع يتيح النشر التلقائي عند كل دفع إلى فرع. المشروع مرخّص بموجب MIT ومؤلّفه Matthew Blode.
Comments
0 people shared their preference · Deer Point appears after 10 participants
Sign in to join the discussion.