GitHub
GitHub is de eenvoudigste manier om een register te hosten. Push uw blokken naar een repository en gebruik de raw-content-URL’s van GitHub.
Instellen
Maak een repository met deze structuur:
acme-blocks/
registry.json
blocks/
hero/
block.json
index.php
card/
block.json
index.php
style.scss
registry.json
Stel baseUrl in op de raw GitHub URL voor uw map 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"]
}
]
}
De baseUrl gebruikt raw.githubusercontent.com zodat de CLI de raw bestandsinhoud ophaalt, niet de pagina GitHub HTML.
Configuratie voor gebruikers
Gebruikers voegen uw register toe aan hun blocks.json:
{
"directory": "blockstudio",
"registries": {
"acme": "https://raw.githubusercontent.com/acme/acme-blocks/main/registry.json"
}
}
Vervolgens:
npx blockstudio add acme/hero
Vastzetten op een release
Gebruik een tag of commit-SHA in plaats van main om een specifieke versie vast te zetten:
{
"registries": {
"acme": "https://raw.githubusercontent.com/acme/acme-blocks/v1.0.0/registry.json"
}
}
Zo voorkomt u dat incompatibele wijzigingen bestaande projecten beïnvloeden, zolang de registry.json op die tag ook de tag in zijn baseUrl gebruikt. De CLI downloadt blokbestanden van baseUrl, dus een getagde registry.json waarvan de baseUrl nog steeds naar main verwijst, installeert de bestanden van main. Hetzelfde geldt voor een commit-SHA: daarmee wordt de bloklijst vastgezet, terwijl de bestanden afkomstig zijn van de ref waarnaar de baseUrl van die commit verwijst.
GitHub Pages
U kunt een register ook aanbieden via GitHub Pages als u de voorkeur geeft aan een nettere URL:
- Schakel GitHub Pages in voor de repository
- Stel
baseUrlin op uw Pages-URL:https://acme.github.io/acme-blocks/blocks - De
registry.jsonis bereikbaar ophttps://acme.github.io/acme-blocks/registry.json
Privérepositories
Gebruik voor privérepositories de objectregisterindeling met een persoonlijk GitHub-toegangstoken:
{
"registries": {
"private": {
"url": "https://raw.githubusercontent.com/acme/private-blocks/main/registry.json",
"headers": {
"Authorization": "Bearer ${GITHUB_TOKEN}"
}
}
}
}
Stel het token in uw omgeving in:
export GITHUB_TOKEN=ghp_abc123
npx blockstudio add private/hero
Het token heeft de scope repo nodig (of contents:read voor fijnmazige tokens) om via raw.githubusercontent.com toegang te krijgen tot inhoud van privérepositories.