website metalsmith

Fastify-website

AVISO :
Este repositório foi a casa anterior do site da Fastify até junho de 2023.
A nova casa agora é fastify/website-next

Este projeto é usado para criar o site para o Fastify Web Framework e publicá -lo online.

Requisitos

• Nó 12+
• Instale dependências com npm install

Construir

Para acionar a construção do site, você só precisa executar:

npm run build

Isso executará todas as etapas necessárias para criar uma construção (site estático).

Se você está desenvolvendo, pode executar:

npm start

Isso acionará a compilação e também iniciará um servidor ao vivo que permitirá visualizar as alterações que você está executando no site.

(Observe que toda vez que você faz uma alteração nos ativos que constituem o conteúdo do site, você precisará lançar npm run build:website para acionar uma reconstrução)

Construir etapas

Caso você esteja interessado em saber mais sobre como o processo de construção funciona, aqui estão as principais etapas executadas durante sua execução:

1. Limpeza : remove os recursos temporários que podem ter criado a partir de uma compilação anterior
2. Criação das pastas de temperatura : cria as pastas necessárias para o processo de construção
3. Obtenha versões : usa as APIs do GitHub para baixar os lançamentos mais recentes do Fastify, para que as páginas de documentação possam ser regeneradas dinamicamente.
4. Liberações de processo : processos os versões que criam todos os arquivos dinâmicos necessários que são derivados das versões do Fastify original (principalmente usadas para gerar e processar páginas de documentação)
5. Geração de sites : usa o Metalsmith para compilar uma versão estática do site.

Consulte os scripts do pacote para entender quais arquivos acionam essas ações, caso você queira ver o código de qualquer uma das etapas descritas acima.

Publicação como páginas do Github

O site é publicado automaticamente Circle CI usando páginas do Github ( gh-pages de Filial).

Toda vez que há uma mudança no mestre, se a construção foi criada com sucesso, ela será publicada automaticamente nas páginas do GitHub.

Para que isso funcione, o Circle CI precisará ser configurado corretamente, fornecendo todas as variáveis ​​de ambiente necessárias:

• DOMAIN : o domínio personalizado a ser usado nas páginas do Github ( www.fastify.io )
• GH_EMAIL : O email do usuário do github autorizado em Circleci a empurrar para a filial gh-pages
• GH_NAME : o nome de usuário do usuário do github autorizado em Circleci a empurrar para o ramo gh-pages
• GH_TOKEN : (opcional) Um token de acesso pessoal do github para o usuário especificado em GH_NAME . Se isso estiver presente, as chamadas da API para o GitHub serão autenticadas.
• CLOUDFLARE_EMAIL : o email da conta Cloudflare
• CLOUDFLARE_AUTH_KEY : a chave de autorização para executar chamadas de API nas APIs CloudFlare
• CLOUDFLARE_ZONE : o ID da zona cloudflare associada ao domínio atual

Contribuindo

Todos são muito bem -vindos para contribuir com este projeto. Você pode contribuir apenas enviando bugs ou sugerindo melhorias abrindo um problema ou enviando uma solicitação de tração.

Licença

Licenciado sob licença do MIT. © Fundação OpenJS e a equipe do Fastify.