Decap CMS & Astro

Decap CMS (anciennement Netlify CMS) est un système de gestion de contenu open-source basé sur Git.

Decap vous permet de profiter pleinement de toutes les fonctionnalités d’Astro, y compris l’optimisation des images et les collections de contenu.

Decap ajoute une route (typiquement /admin) à votre projet qui chargera une application React pour permettre aux utilisateurs autorisés de gérer le contenu directement depuis le site web déployé. Decap commettra les changements directement dans le référentiel source de votre projet Astro.

Installation de DecapCMS

Il existe deux options pour ajouter Decap à Astro :

Installer Decap via un gestionnaire de paquets avec la commande suivante :
- npm
- pnpm
- Yarn
Fenêtre de terminal
npm install decap-cms-app
Fenêtre de terminal
pnpm add decap-cms-app
Fenêtre de terminal
yarn add decap-cms-app

Importez le paquet dans une balise <script> de votre page <body>

 <body>
   <!-- Inclure le script qui construit la page et alimente Decap CMS -->
   <script src="https://unpkg.com/decap-cms@^3.1.2/dist/decap-cms.js"></script>
 </body>

Configuration

Créez un dossier d’administration statique dans public/admin/
Ajoutez config.yml à public/admin/ :
- Répertoirepublic
  - Répertoireadmin
    config.yml

Pour ajouter le support des collections de contenu, configurez chaque schéma dans config.yml. L’exemple suivant configure une collection blog, en définissant un label pour la propriété frontmatter de chaque entrée :

collections:
  - name: "blog" # Utilisé dans les routes, par exemple, /admin/collections/blog
    label: "Blog" # Utilisé dans l'UI
    folder: "src/content/blog" # Chemin d'accès au dossier dans lequel les documents sont stockés
    create: true # Permettre aux utilisateurs de créer de nouveaux documents dans cette collection
    fields: # Les champs de chaque document, généralement en tête de page
      - { label: "Layout", name: "layout", widget: "hidden", default: "blog" }
      - { label: "Title", name: "title", widget: "string" }
      - { label: "Publish Date", name: "date", widget: "datetime" }
      - { label: "Featured Image", name: "thumbnail", widget: "image" }
      - { label: "Rating (scale of 1-5)", name: "rating", widget: "number" }
      - { label: "Body", name: "body", widget: "markdown" }

Ajoutez la route admin pour votre application React. Ce fichier peut-être soit public/admin/index.html à côté de votre config.yml ou, si vous préférez utiliser une route Astro, src/pages/admin.astro.

Répertoirepublic
- Répertoireadmin
  - config.yml
  - index.html

<!doctype html>
<html lang="fr">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <meta name="robots" content="noindex" />
    <link href="/admin/config.yml" type="text/yaml" rel="cms-config-url" />
    <title>Gestionnaire de contenu</title>
  </head>
  <body>
    <script src="https://unpkg.com/decap-cms@^3.1.2/dist/decap-cms.js"></script>
  </body>
</html>

Pour permettre le téléchargement de médias dans un dossier spécifique via l’éditeur Decap, ajoutez un chemin d’accès approprié :

 media_folder: "src/assets/images" # Emplacement où les fichiers seront stockés dans le dépôt
 public_folder: "src/assets/images" # L'attribut src pour les médias téléchargés

Voir la documentation de configuration du CMS Decap pour des instructions et des options complètes.

Utilisation

Naviguez vers votre site.com/admin/ pour utiliser l’éditeur de Decap CMS.

Authentification

Decap CMS avec Netlify Identity

Decap CMS a été développé à l’origine par Netlify et dispose d’un support pour Netlify Identity.

Lors du déploiement sur Netlify, configurez l’identité pour votre projet via le tableau de bord Netlify et incluez le Netlify Identity Widget sur la route admin de votre projet. Vous pouvez également inclure le widget d’identité sur la page d’accueil de votre site si vous prévoyez d’inviter de nouveaux utilisateurs par e-mail.