expressjs.com

Expressjs.com

Este es el repositorio del sitio web expressjs.com. Está alojado directamente desde el repositorio como un sitio web de GitHub Pages.

Configuración local

Para obtener una vista previa del sitio web localmente:

1. Instale Ruby y Bundler si aún no los tiene.

2. Instale la gema jekyll-redirect-from:

   $ gem install jekyll-redirect-from

3. Clon este repositorio ejecutando el siguiente comando:

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

4. Navegue al directorio de repositorio clonado y ejecute el siguiente comando:

   $ bundle install

   Bundler buscará en el archivo de Gems para las gemas para instalar. La gema github-pages incluye la misma versión de Jekyll y otras dependencias utilizadas por las páginas de GitHub, de modo que su configuración local refleja las páginas de GitHub lo más cerca posible.

5. Ejecute Jekyll usando el siguiente comando:

   $ bundle exec jekyll serve

   Luego, cargue http: // localhost: 4000 en su navegador.

Configuración local usando Docker

Consejo

Puede ejecutar make help para obtener información detallada sobre cómo usar nuestros comandos Make.

0. Asegúrese de tener Docker e Instalado.
1. Ejecutar make build para construir el proyecto.
2. Run make serve para servir al proyecto, esto incluye la recarga en vivo para que se reflejará cualquier cambio (puede llevar un tiempo, verifique los registros).
3. Ejecute make clean para eliminar las imágenes y los recursos de Docker generados.

Formato

Jekyll usa una variante de Markdown conocida como Kramdown.

Jekyll usa el motor de plantilla de líquido para la plantilla.

Puede usar bloques de código vados GFM para JavaScript; Por ejemplo:

 `` `JS
var express = require ('express')
VAR App = Express ()
App.listen (3000)
`` `` ``

El resultado se ve así:

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

El resaltado predeterminado de la sintaxis de GitHub se ha deshabilitado en _config.yml para permitir el resaltado con prism.js.

Que contribuye

Siéntase libre de hacer cambios en los archivos de plantilla o los archivos de documento. Los documentos de apoyo se encuentran en sus respectivos directorios, y los documentos de API se encuentran bajo el directorio _includes .

Consulte la Guía de contribuyentes para obtener más información sobre cómo contribuir a la documentación, incluida la información sobre las traducciones contribuyentes.

¿Por qué usar Jekyll en lugar de una solución basada en Express?

Jekyll viene incorporado con páginas Github. Dado que ya estamos utilizando páginas GitHub para alojar el sitio web, tiene sentido aprovechar las capacidades que proporciona. Se trata de usar la herramienta adecuada, para el trabajo adecuado, en las circunstancias correctas.