website metalsmith

Fastify-Website

ADVERTENCIA :
Este repositorio fue el hogar anterior del sitio web de Fastify hasta junio de 2023.
El nuevo hogar ahora es fastify/website-next

Este proyecto se utiliza para crear el sitio web para Fastify Web Framework y publicarlo en línea.

Requisitos

• Nodo 12+
• Instalar dependencias con npm install

Construir

Para activar la compilación del sitio web, solo necesita ejecutar:

npm run build

Esto ejecutará todos los pasos necesarios para crear una compilación (sitio web estático).

Si está desarrollando, puede ejecutar:

npm start

Esto activará la compilación y también iniciará un servidor en vivo que le permitirá visualizar los cambios que está realizando en el sitio web.

(Tenga en cuenta que cada vez que realice un cambio en los activos que constituyen el contenido del sitio web, deberá iniciar npm run build:website para activar una reconstrucción)

Pasos de construcción

En caso de que esté interesado en saber más sobre cómo funciona el proceso de compilación, aquí están los pasos principales que se realizan durante su ejecución:

1. Limpieza : elimina los recursos temporales que podrían haber creado a partir de una compilación anterior
2. Creación de carpetas temperaturas : crea las carpetas necesarias para el proceso de compilación
3. Obtenga versiones : utiliza las API de GitHub para descargar las últimas versiones de Fastify para que las páginas de documentación puedan regenerarse dinámicamente.
4. Lanzamientos de proceso : procesa las versiones creando todos los archivos dinámicos necesarios que se derivan de las versiones de Fastify originales (se utilizan principalmente para generar y procesar páginas de documentación)
5. Generación del sitio web : utiliza Metalsmith para compilar una versión estática del sitio web.

Consulte los scripts del paquete para comprender qué archivos activan estas acciones en caso de que desee echar un vistazo al código para cualquiera de los pasos descritos anteriormente.

Publicar como páginas de Github

El sitio web se publica automáticamente Circle CI utilizando páginas GitHub (Branch gh-pages ).

Cada vez que hay un cambio en Master, si la construcción se creó con éxito, entonces se publica automáticamente en las páginas de GitHub.

Para que esto funcione, Circle CI deberá configurarse correctamente, proporcionando todas las variables de entorno necesarias:

• DOMAIN : el dominio personalizado que se utilizará en las páginas de GitHub ( www.fastify.io )
• GH_EMAIL : El correo electrónico del usuario de GitHub autorizado en Circleci para llevar a la rama gh-pages
• GH_NAME : el nombre de usuario del usuario de GitHub autorizado en Circleci para llevar a la rama gh-pages
• GH_TOKEN : (Opcional) Un token de acceso personal GitHub para el usuario especificado en GH_NAME . Si esto está presente, las llamadas API a GitHub se autenticarán.
• CLOUDFLARE_EMAIL : el correo electrónico de la cuenta de CloudFlare
• CLOUDFLARE_AUTH_KEY : la clave de autorización para realizar llamadas API en las API de CloudFlare
• CLOUDFLARE_ZONE : la ID de la zona de CloudFlare asociada al dominio actual

Que contribuye

Todos son bienvenidos para contribuir a este proyecto. Puede contribuir simplemente enviando errores o sugeriendo mejoras abriendo un problema o enviando una solicitud de extracción.

Licencia

Licenciado bajo licencia MIT. © OpenJS Foundation y el equipo de Fastify.