Builder.io & Astro
Builder.io est un CMS visuel qui prend en charge l’édition de contenu par glisser-déposer pour la construction de sites Web.
Cette recette vous montrera comment connecter votre espace Builder à Astro avec zéro JavaScript côté client.
Prérequis
Section intitulée « Prérequis »Pour commencer, vous devez disposer des éléments suivants :
- Un compte et un espace Builder - Si vous n’avez pas encore de compte, inscrivez-vous gratuitement et créez un nouvel espace. Si vous avez déjà un espace avec Builder, n’hésitez pas à l’utiliser, mais vous devrez modifier le code pour qu’il corresponde au nom du modèle (
blogpost) et aux champs de données personnalisées. - Une clé API Builder - Cette clé publique sera utilisée pour récupérer votre contenu depuis Builder. Lire le guide de Builder sur la façon de trouver votre clé.
Configuration des informations d’identification
Section intitulée « Configuration des informations d’identification »Pour ajouter votre clé API Builder et votre nom de modèle Builder à Astro, créez un fichier .env à la racine de votre projet (s’il n’existe pas déjà) et ajoutez les variables suivantes :
BUILDER_API_PUBLIC_KEY=VOTRE_CLE_APIBUILDER_BLOGPOST_MODEL='blogpost'Maintenant, vous devriez pouvoir utiliser cette clé API dans votre projet.
Au moment de la rédaction, cette clé est publique, vous n’avez donc pas à vous soucier de la cacher ou de la chiffrer.
Si vous voulez avoir IntelliSense pour vos variables d’environnement, vous pouvez créer un fichier env.d.ts dans le répertoire src/ et configurer ImportMetaEnv comme ceci :
interface ImportMetaEnv { readonly BUILDER_API_PUBLIC_KEY: string;}Votre projet doit maintenant inclure ces fichiers :
Répertoiresrc/
- env.d.ts
- .env
- astro.config.mjs
- package.json
.env dans Astro.
Créer un blog avec Astro et Builder
Section intitulée « Créer un blog avec Astro et Builder »Création d’un modèle pour un article de blog
Section intitulée « Création d’un modèle pour un article de blog »Les instructions ci-dessous créent un blog Astro en utilisant un modèle Builder (Type : “Section”) appelé blogpost qui contient deux champs texte obligatoires : title et slug.
Vous pouvez trouver des vidéos montrant cette procédure dans l’un des tutoriels officiels de Builder.
Dans l’application Builder, créez le modèle qui représentera un article de blog : allez dans l’onglet Models et cliquez sur le bouton + Create Model pour créer un modèle avec les champs et valeurs suivants :
- Type: Section
- Name: « blogpost »
- Description: « Ce modèle est destiné à un article de blog »
Dans votre nouveau modèle, utilisez le bouton + New Custom Field pour créer deux nouveaux champs :
-
Champ texte
- Name: « title »
- Required: Yes
- Default value « J’ai oublié de donner un titre à ce champ »
(laisser les autres paramètres par défaut)
-
Champ texte
- Name: « slug »
- Required: Yes
- Default value « certaines-limaces-prennent-leur-temps »
(laisser les autres paramètres par défaut)
Cliquez ensuite sur le bouton Save en haut à droite.
Il y a quelques pièges avec le champ slug :
-
Assurez-vous que votre mot-clé n’est pas un simple nombre. Cela semble interrompre la requête de récupération à l’API de Builder.
-
Assurez vous que vos slugs sont uniques, car le routage de votre site dépendra de cela.
Mise en place de la prévisualisation
Section intitulée « Mise en place de la prévisualisation »Pour utiliser l’éditeur visuel de Builder, créez la page src/pages/builder-preview.astro qui générera le composant spécial <builder-component> :
Répertoiresrc/
Répertoirepages/
- builder-preview.astro
- env.d.ts
- .env
- astro.config.mjs
- package.json
Ajoutez ensuite le contenu suivant :
---const builderAPIpublicKey = import.meta.env.BUILDER_API_PUBLIC_KEY;const builderModel = import.meta.env.BUILDER_BLOGPOST_MODEL;---
<html lang="fr"> <head> <title>Aperçu pour builder.io</title> </head> <body> <header>Ceci est votre header</header>
<builder-component model={builderModel} api-key={builderAPIpublicKey} ></builder-component> <script async src="https://cdn.builder.io/js/webcomponents"></script>
<footer>Ceci est votre footer</footer> </body></html>