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/:
{
"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:
{
"directory": "blockstudio",
"registries": {
"acme": "https://raw.githubusercontent.com/acme/acme-blocks/main/registry.json"
}
}
След това:
npx blockstudio add acme/hero
Фиксиране към издание
За да фиксирате конкретна версия, използвайте етикет или SHA на комит вместо main:
{
"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:
- Активирайте GitHub Pages за хранилището
- Задайте
baseUrlна URL за Pages:https://acme.github.io/acme-blocks/blocks registry.jsonе достъпен на адресhttps://acme.github.io/acme-blocks/registry.json
Частни хранилища
За частни хранилища използвайте формата на регистъра с обекти и личен токен за достъп GitHub:
{
"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.