expressjs.com

expressjs.com

Ceci est le référentiel du site Web ExpressJs.com. Il est hébergé directement à partir du référentiel en tant que site Web de pages GitHub.

Configuration locale

Pour prévisualiser le site Web localement:

1. Installez Ruby et Bundler si vous ne les avez pas déjà.

2. Installez le bijou Jekyll-Redirect-From:

   $ gem install jekyll-redirect-from

3. Clone ce référentiel en exécutant la commande suivante:

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

4. Accédez au répertoire du référentiel cloné et exécutez la commande suivante:

   $ bundle install

   Bundler sera consacré au Gemfile pour lequel installer les gemmes. Le gemme github-pages comprend la même version de Jekyll et d'autres dépendances utilisées par les pages GitHub, de sorte que votre configuration locale reflète les pages GitHub aussi étroitement que possible.

5. Exécutez Jekyll en utilisant la commande suivante:

   $ bundle exec jekyll serve

   Ensuite, chargez http: // localhost: 4000 dans votre navigateur.

Configuration locale à l'aide de Docker

Conseil

Vous pouvez exécuter make help à obtenir pour obtenir des informations détaillées sur la façon d'utiliser nos commandes de marque.

0. Assurez-vous que vous avez Docker et que vous vous installiez.
1. Exécutez make build pour construire le projet.
2. Run make serve servir le projet, cela inclut le rechargement en direct afin que tout changement soit reflété (cela peut prendre un certain temps, vérifier les journaux).
3. Exécutez make clean pour supprimer les images et les ressources Docker générées.

Formatage

Jekyll utilise une variante de Markdown connue sous le nom de Kramdown.

Jekyll utilise le moteur de matrice liquide pour les modèles.

Vous pouvez utiliser des blocs de code clôturés GFM pour JavaScript; Par exemple:

 `` JS
var express = require ('express')
var app = express ()
app.Listen (3000)
`` '

Le résultat ressemble à ceci:

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

La mise en évidence par défaut de syntaxe des pages GitHub par défaut a été désactivée dans _config.yml pour permettre la mise en évidence avec Prism.js.

Contributif

N'hésitez pas à apporter des modifications aux fichiers de modèle ou aux fichiers de document. Les documents de support sont situés dans leurs répertoires respectifs et les documents API sont situés dans le répertoire _includes .

Veuillez consulter le Guide des contributeurs pour plus d'informations sur la contribution à la documentation, y compris les informations sur les traductions contributives.

Pourquoi utiliser Jekyll au lieu d'une solution expresse?

Jekyll est intégré avec des pages GitHub. Étant donné que nous utilisons déjà des pages GitHub pour héberger le site Web, il est logique de tirer parti des capacités qu'il fournit. Il s'agit d'utiliser le bon outil, pour le bon travail, dans les bonnes circonstances.