ghost static website generator

Générateur de sites Web statiques fantômes

Générez des fichiers HTML statiques pour un hébergement fantôme personnalisé et publiez-les sur AWS S3 en tant que site Web statique. Pour héberger le site de blog statique sous un chemin /blog ( https://yourdomain.com/blog ), le fantôme doit être hébergé avec le même chemin comme https://content.yourdomain.com/blog .

Si votre blog est hébergé sous https://content.yourdomain.com et que vous souhaitez héberger le site Web statique sous https://yourdomain.com/blog , cela n'est pas possible. Il en va de même pour l’inverse.

Vous pouvez également remplacer certains textes des fichiers statiques générés en passant les arguments suivants custom_replace_keys et custom_replace_values ​​. Pour plus de détails, reportez-vous à la section Entrées et exemple d'utilisation. Il ne prend pas en charge le remplacement multiligne pour le moment.

En option, vous pouvez héberger les fichiers statiques sur AWS S3 ou sur AWS Amplify.

Pour héberger un blog statique sur AWS S3, fournissez les paramètres d'entrée suivants :

• s3_bucket_name (Rendre le bucket accessible au public et activer l'hébergement Web statique)

• aws_access_key_id

• aws_secret_access_key

• aws_region

Pour héberger un blog statique sur une application AWS Amplify déjà existante, fournissez les paramètres d'entrée suivants :

• aws_amplify_app_id

• aws_amplify_branch_name

• aws_access_key_id

• aws_secret_access_key

• aws_region

Entrées

ghost_hosted_url

Point de terminaison d’URL hébergé par Ghost requis . ( ex: https://content.yourdomain.com/blog )

ghost_static_host_url

Point de terminaison d’URL requis où les fichiers statiques doivent être hébergés. ( ex: https://yourdomain.com/blog )

custom_replace_keys

Liste facultative des éléments séparés par des virgules qui doivent être remplacés par les éléments de custom_replace_values ​​au même index.

custom_replace_values

Valeurs associées facultatives séparées par des virgules pour l'élément dans custom_replace_keys.

root_index_jsonld

Facultatif Remplacez les données ld+json dans le fichier d’index racine.

breadcrumb_root_index_jsonld

Facultatif Ajoutez les données Breadcrumb ld+json dans le fichier d'index racine.

s3_bucket_name

Nom du compartiment S3 facultatif pour télécharger des fichiers HTML statiques.

aws_access_key_id

ID de clé d'accès AWS facultatif .

aws_secret_access_key

Clé d'accès secrète AWS facultative .

aws_region

Région AWS facultative .

aws_amplify_app_id

Identifiant de l’application Amplify facultatif .

aws_amplify_branch_name

Nom de la branche Amplify facultatif .

Exemple d'utilisation

 name : Generate Static HTML files
uses : TrueSparrowSystems/ghost-static-website-generator@v4
with :
  ghost_hosted_url : " https://content.yourdomain.com/blog "
  ghost_static_host_url : " https://yourdomain.com/blog "
  s3_bucket_name : " your-s3-bucket-name "
  aws_access_key_id : ${{ secrets.AWS_ACCESS_KEY_ID }} # Accessing it from the gihub secrets
  aws_secret_access_key : ${{ secrets.AWS_SECRET_ACCESS_KEY }} # Accessing it from the gihub secrets
  aws_region : " us-east-1 "
  custom_replace_keys : " key_1, key_2, key_n "
  custom_replace_values : " value_1, value_2, value_n "

Construire et exécuter localement avec Docker

docker build -t ghost-swg .
docker run -it --env-file .env.sample ghost-swg

Apportez les modifications appropriées au fichier .env.sample . Pour conserver les fichiers HTML générés dans le répertoire local (système hôte), utilisez l'option de montage bind avec la commande docker run , par exemple : -v /path/to/local/dir:/src/content