Pereiti prie turinio

GitHub

GitHub yra paprasčiausias būdas patalpinti registrą. Įkelkite savo blokus į saugyklą ir naudokite neapdoroto turinio URL adresus iš GitHub.

Nustatymas

Sukurkite šios struktūros saugyklą:

Kodas
acme-blocks/
  registry.json
  blocks/
    hero/
      block.json
      index.php
    card/
      block.json
      index.php
      style.scss

registry.json

Nustatykite baseUrl į neapdorotą GitHub URL savo blocks/ katalogui:

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 naudoja raw.githubusercontent.com, kad CLI gautų neapdoroto failo turinį, o ne GitHub HTML puslapį.

Vartotojo konfigūracija

Vartotojai įtraukia jūsų registrą į savo blocks.json:

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

Tada:

Shell
npx blockstudio add acme/hero

Versijos fiksavimas

Norėdami fiksuoti konkrečią versiją, vietoj main naudokite žymą arba įrašo SHA:

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

Taip apsaugoma, kad nesuderinami pakeitimai nepaveiktų esamų projektų, jei tik toje žymoje esantis registry.json savo baseUrl taip pat naudoja žymą. CLI atsisiunčia blokų failus iš baseUrl, todėl pažymėtas registry.json, kurio baseUrl vis dar nurodo į main, įdiegia failus iš main. Tas pats taikoma ir įrašo SHA: jis fiksuoja blokų sąrašą, o failai gaunami iš tos nuorodos, kurią nurodo to įrašo baseUrl.

GitHub Pages

Jei norite švaresnio URL, registrą taip pat galite pateikti per GitHub Pages:

  1. Įjunkite saugyklos GitHub Pages
  2. Nustatykite baseUrl į savo Pages URL: https://acme.github.io/acme-blocks/blocks
  3. registry.json pasiekiamas adresu https://acme.github.io/acme-blocks/registry.json

Privačios saugyklos

Privačioms saugykloms naudokite objektų registro formatą su GitHub asmeniniu prieigos raktu:

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

Nustatykite prieigos raktą aplinkoje:

Shell
export GITHUB_TOKEN=ghp_abc123
npx blockstudio add private/hero

Norint per raw.githubusercontent.com pasiekti privačios saugyklos turinį, prieigos raktui reikia repo apimties (arba contents:read, jei naudojami ribotos apimties prieigos raktai).