GitHub
GitHub je najpreprostejši način za gostovanje registra. Potisnite svoje bloke v repozitorij in uporabite neobdelane URL-je vsebine na GitHub.
Nastavitev
Ustvarite repozitorij s to strukturo:
acme-blocks/
registry.json
blocks/
hero/
block.json
index.php
card/
block.json
index.php
style.scss
registry.json
Nastavite baseUrl na neobdelani GitHub URL svojega imenika 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 uporablja raw.githubusercontent.com, da CLI pridobi neobdelano vsebino datoteke, ne pa strani GitHub HTML.
Konfiguracija porabnika
Uporabniki dodajo vaš register v svoj blocks.json:
{
"directory": "blockstudio",
"registries": {
"acme": "https://raw.githubusercontent.com/acme/acme-blocks/main/registry.json"
}
}
Nato:
npx blockstudio add acme/hero
Pripenjanje na izdajo
Če želite pripeti določeno različico, namesto main uporabite oznako ali SHA potrditve:
{
"registries": {
"acme": "https://raw.githubusercontent.com/acme/acme-blocks/v1.0.0/registry.json"
}
}
To prepreči, da bi spremembe, ki prekinejo združljivost, vplivale na obstoječe projekte, če registry.json pri tej oznaki uporablja isto oznako v svojem baseUrl. CLI prenaša datoteke blokov iz baseUrl, zato registry.json z oznako, katerega baseUrl še vedno kaže na main, namesti datoteke iz main. Enako velja za SHA potrditve: pripne seznam blokov, datoteke pa pridejo iz reference, ki jo poimenuje baseUrl te potrditve.
GitHub Pages
Register lahko ponudite tudi prek GitHub Pages, če želite čistejši URL:
- Omogočite GitHub Pages za repozitorij
- Nastavite
baseUrlna svoj Pages URL:https://acme.github.io/acme-blocks/blocks registry.jsonje dostopen nahttps://acme.github.io/acme-blocks/registry.json
Zasebni repozitoriji
Za zasebne repozitorije uporabite obliko registra objektov z osebnim žetonom za dostop GitHub:
{
"registries": {
"private": {
"url": "https://raw.githubusercontent.com/acme/private-blocks/main/registry.json",
"headers": {
"Authorization": "Bearer ${GITHUB_TOKEN}"
}
}
}
}
Žeton nastavite v okolju:
export GITHUB_TOKEN=ghp_abc123
npx blockstudio add private/hero
Za dostop do vsebine zasebnega repozitorija prek raw.githubusercontent.com žeton potrebuje obseg repo (ali contents:read pri žetonih z natančno določenimi pravicami).