GitHub
Το GitHub είναι ο απλούστερος τρόπος φιλοξενίας ενός μητρώου. Στείλτε τα blocks σας σε ένα αποθετήριο και χρησιμοποιήστε τις διευθύνσεις 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 commit αντί για main:
{
"registries": {
"acme": "https://raw.githubusercontent.com/acme/acme-blocks/v1.0.0/registry.json"
}
}
Έτσι οι υπάρχουσες εργασίες προστατεύονται από αλλαγές που προκαλούν ασυμβατότητες, αρκεί το registry.json σε αυτή την ετικέτα να χρησιμοποιεί επίσης την ετικέτα στο baseUrl του. Το CLI κατεβάζει αρχεία block από το baseUrl, επομένως ένα registry.json με ετικέτα, του οποίου το baseUrl εξακολουθεί να δείχνει στο main, εγκαθιστά τα αρχεία από το main. Το ίδιο ισχύει για ένα SHA commit: καρφιτσώνει τη λίστα των block, ενώ τα αρχεία προέρχονται από όποια αναφορά ονομάζει το baseUrl αυτού του commit.
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
Ιδιωτικά αποθετήρια
Για ιδιωτικά αποθετήρια, χρησιμοποιήστε τη μορφή μητρώου αντικειμένων με προσωπικό token πρόσβασης GitHub:
{
"registries": {
"private": {
"url": "https://raw.githubusercontent.com/acme/private-blocks/main/registry.json",
"headers": {
"Authorization": "Bearer ${GITHUB_TOKEN}"
}
}
}
}
Ορίστε το token στο περιβάλλον σας:
export GITHUB_TOKEN=ghp_abc123
npx blockstudio add private/hero
Το token χρειάζεται το πεδίο εφαρμογής repo (ή contents:read για token περιορισμένης πρόσβασης) για πρόσβαση σε περιεχόμενο ιδιωτικού αποθετηρίου μέσω του raw.githubusercontent.com.