expressjs.com

Expressjs.com

Este é o repositório do site expressjs.com. Ele é hospedado diretamente do repositório como um site de páginas do Github.

Configuração local

Para visualizar o site localmente:

1. Instale o Ruby e o Matingler, se você ainda não os possui.

2. Instale a jóia Jekyll-Redirect-From:

   $ gem install jekyll-redirect-from

3. Clone este repositório executando o seguinte comando:

   $ git clone https://github.com/expressjs/expressjs.com.git

4. Navegue até o diretório de repositório clonado e execute o seguinte comando:

   $ bundle install

   O Bundler procurará no GemFile para quais gems instalarem. A gema github-pages inclui a mesma versão de Jekyll e outras dependências usadas pelas páginas do Github, para que sua configuração local espelha as páginas do GitHub o mais próximo possível.

5. Execute Jekyll usando o seguinte comando:

   $ bundle exec jekyll serve

   Em seguida, carregue http: // localhost: 4000 no seu navegador.

Configuração local usando Docker

Dica

Você pode executar make help para obter informações detalhadas sobre como usar nossos comandos Make.

0. Certifique -se de ter o Docker e instalar instalado.
1. Run make build para construir o projeto.
2. Run make serve para servir o projeto, isso inclui recarregar ao vivo para que qualquer alteração seja refletida (pode demorar um pouco, verifique os logs).
3. Execute make clean para remover as imagens e os recursos do Docker gerados.

Formatação

Jekyll usa uma variante de Markdown conhecida como Kramdown.

Jekyll usa o mecanismo de modelo líquido para modelagem.

Você pode usar blocos de código cercado GFM para JavaScript; por exemplo:

 `` `JS
var express = requer ('expresso')
var app = express ()
App.Listen (3000)
`` `

O resultado é assim:

 const express = require ( 'express' )
const app = express ( )
app . listen ( 3000 )

A sintaxe do GitHub padrão do github foi desativada em _config.yml para permitir o destaque com o prism.js.

Contribuindo

Sinta -se à vontade para fazer alterações nos arquivos de modelo ou nos arquivos do documento. Os documentos de apoio estão localizados em seus respectivos diretórios, e os documentos da API estão localizados no diretório _includes .

Consulte o Guia dos Contribuidores para obter mais informações sobre como contribuir para a documentação, incluindo informações sobre traduções contribuintes.

Por que usar o Jekyll em vez de uma solução baseada em Express?

Jekyll vem embutido com páginas do GitHub. Como já estamos usando as páginas do Github para hospedar o site, faz sentido alavancar os recursos que ele oferece. Trata -se de usar a ferramenta certa, para o trabalho certo, nas circunstâncias certas.