انتقل إلى المحتوى

GitHub

GitHub أبسط طريقة لاستضافة سجل. ادفع كتلَك إلى مستودع واستخدم عناوين URL للمحتوى الخام في GitHub.

الإعداد

أنشئ مستودعًا بهذا الهيكل:

الكود
acme-blocks/
  registry.json
  blocks/
    hero/
      block.json
      index.php
    card/
      block.json
      index.php
      style.scss

registry.json

اضبط baseUrl على GitHub الخام من نوع URL لدليل blocks/ لديك:

JSON
{
  "name": "acme",
  "description": "Acme Corp block library.",
  "baseUrl": "https://raw.githubusercontent.com/acme/acme-blocks/main/blocks",
  "blocks": [
    {
      "name": "hero",
      "title": "Hero",
      "category": "layout",
      "type": "blockstudio",
      "files": ["block.json", "index.php"]
    },
    {
      "name": "card",
      "title": "Card",
      "category": "components",
      "type": "blockstudio",
      "files": ["block.json", "index.php", "style.scss"]
    }
  ]
}

يستخدم baseUrl raw.githubusercontent.com ليحصل CLI على محتوى الملف الخام، لا صفحة GitHub HTML.

إعدادات المستهلك

يضيف المستخدمون سجلك إلى blocks.json لديهم:

JSON
{
  "directory": "blockstudio",
  "registries": {
    "acme": "https://raw.githubusercontent.com/acme/acme-blocks/main/registry.json"
  }
}

ثم:

سطر الأوامر
npx blockstudio add acme/hero

التثبيت على إصدار محدد

للتثبيت على إصدار محدد، استخدم وسمًا أو SHA للإيداع بدلًا من main:

JSON
{
  "registries": {
    "acme": "https://raw.githubusercontent.com/acme/acme-blocks/v1.0.0/registry.json"
  }
}

يمنع هذا التغييرات غير المتوافقة من التأثير في المشاريع الحالية، ما دام registry.json عند ذلك الوسم يستخدم أيضًا الوسم في baseUrl الخاص به. ينزّل CLI ملفات الكتل من baseUrl، لذا فإن registry.json الموسوم الذي لا يزال baseUrl فيه يشير إلى main يثبّت الملفات من main. وينطبق الأمر نفسه على SHA الإيداع: فهو يثبّت قائمة الكتل، بينما تأتي الملفات من المرجع الذي يسميه baseUrl لذلك الإيداع.

GitHub Pages

يمكنك أيضًا استضافة سجل عبر GitHub Pages إذا كنت تفضّل URL أكثر ترتيبًا:

  1. فعّل GitHub Pages للمستودع
  2. اضبط baseUrl على URL الخاص بـ Pages: https://acme.github.io/acme-blocks/blocks
  3. يمكن الوصول إلى registry.json عبر https://acme.github.io/acme-blocks/registry.json

المستودعات الخاصة

للمستودعات الخاصة، استخدم تنسيق سجل الكائنات مع رمز وصول شخصي GitHub:

JSON
{
  "registries": {
    "private": {
      "url": "https://raw.githubusercontent.com/acme/private-blocks/main/registry.json",
      "headers": {
        "Authorization": "Bearer ${GITHUB_TOKEN}"
      }
    }
  }
}

اضبط الرمز في بيئتك:

سطر الأوامر
export GITHUB_TOKEN=ghp_abc123
npx blockstudio add private/hero

يحتاج الرمز إلى النطاق repo (أو contents:read للرموز دقيقة الصلاحيات) للوصول إلى محتوى المستودع الخاص عبر raw.githubusercontent.com.