website metalsmith

Fintify-website

AVERTISSEMENT :
Ce référentiel était le domicile précédent du site Web Fitftify jusqu'en juin 2023.
La nouvelle maison est désormais fastify/website-next

Ce projet est utilisé pour créer le site Web pour agrandir le framework Web et le publier en ligne.

Exigences

• Nœud 12+
• Installer les dépendances avec npm install

Construire

Pour déclencher la construction du site Web, vous avez juste besoin d'exécuter:

npm run build

Cela exécutera toutes les étapes nécessaires pour créer une version (site Web statique).

Si vous développez, vous pouvez courir:

npm start

Cela déclenchera la construction et démarrera également un serveur en direct qui vous permettra de visualiser les modifications que vous effectuez sur le site Web.

(Notez que chaque fois que vous apportez une modification des actifs qui constitue le contenu du site Web, vous devrez lancer npm run build:website pour déclencher une reconstruction)

Construire des étapes

Dans le cas où vous souhaitez en savoir plus sur le fonctionnement du processus de construction, voici les principales étapes qui sont effectuées lors de son exécution:

1. Nettoyage : supprime les ressources temporaires qui auraient pu créer à partir d'une construction précédente
2. Création des dossiers temporaires : crée les dossiers nécessaires pour le processus de construction
3. Obtenez des versions : utilise les API GitHub pour télécharger les dernières versions de Fastify afin que les pages de documentation puissent être régénérées dynamiquement.
4. Reliminaires de processus : traite les versions créant tous les fichiers dynamiques nécessaires qui sont dérivés des versions d'origine (principalement utilisées pour générer et traiter les pages de documentation)
5. Génération du site Web : utilise Metalsmith pour compiler une version statique du site Web.

Découvrez les scripts du package pour comprendre quels fichiers déclenchent ces actions au cas où vous souhaitez consulter le code pour l'une des étapes décrites ci-dessus.

Publication en pages GitHub

Le site Web est publié automatiquement en cercle CI à l'aide des pages GitHub (branche gh-pages ).

Chaque fois qu'il y a un changement sur Master, si la construction a été créée avec succès, il est automatiquement publié sur les pages GitHub.

Pour que cela fonctionne, le cercle CI devra être configuré correctement en fournissant toutes les variables d'environnement nécessaires:

• DOMAIN : le domaine personnalisé à utiliser dans les pages GitHub ( www.fastify.io )
• GH_EMAIL : l'e-mail de l'utilisateur GitHub autorisé dans Circleci à pousser à la branche gh-pages
• GH_NAME : Le nom d'utilisateur de l'utilisateur GitHub autorisé dans Circleci à pousser à la branche gh-pages
• GH_TOKEN : (facultatif) Un jeton d'accès personnel GitHub pour l'utilisateur spécifié dans GH_NAME . Si cela est présent, les appels API à GitHub seront authentifiés.
• CLOUDFLARE_EMAIL : l'e-mail du compte Cloudflare
• CLOUDFLARE_AUTH_KEY : la clé d'autorisation pour effectuer des appels d'API sur les API CloudFlare
• CLOUDFLARE_ZONE : l'ID de la zone Cloudflare associée au domaine actuel

Contributif

Tout le monde est le bienvenu pour contribuer à ce projet. Vous pouvez contribuer simplement en soumettant des bogues ou en suggérant des améliorations en ouvrant un problème ou en envoyant une demande de traction.

Licence

Licencié sous licence MIT. © OpenJS Foundation et l'équipe Fastify.