expressjs.com

Expressjs.com

Dies ist das Repository der Website expressjs.com. Es wird direkt aus dem Repository als GitHub Pages -Website gehostet.

Lokales Setup

Um die Website vor Ort anzunehmen:

1. Installieren Sie Ruby und Bundler, wenn Sie sie noch nicht haben.

2. Installieren Sie das Jekyll-Red-From-Juwel:

   $ gem install jekyll-redirect-from

3. Klonen Sie dieses Repository, indem Sie den folgenden Befehl ausführen:

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

4. Navigieren Sie zum geklonten Repository -Verzeichnis und führen Sie den folgenden Befehl aus:

   $ bundle install

   Bundler wird in der GemFile suchen, für die Edelsteine ​​installiert werden sollen. Das github-pages -Juwel enthält dieselbe Version von Jekyll und andere Abhängigkeiten, die von Github-Seiten verwendet werden, sodass Ihre lokalen Setup-Github-Seiten so genau wie möglich spiegeln.

5. Führen Sie Jekyll mit dem folgenden Befehl aus:

   $ bundle exec jekyll serve

   Laden Sie dann http: // localhost: 4000 in Ihren Browser.

Lokales Setup mit Docker

Tipp

Sie können helfen make help , um detaillierte Informationen zur Verwendung unserer Befehle zu erhalten.

0. Stellen Sie sicher, dass Sie Docker haben und installiert machen.
1. Run make build , um das Projekt zu erstellen.
2. Run make serve , um dem Projekt zu dienen. Dazu gehört das Live -Nachladen, sodass jede Änderung reflektiert wird (es kann eine Weile dauern, die Protokolle überprüfen).
3. Run make clean , um die generierten Docker -Bilder und -Ressourcen zu entfernen.

Formatierung

Jekyll verwendet eine Variante von Markdown, die als Kramdown bekannt ist.

Jekyll verwendet die Flüssigkeitsvorlagemotor zum Vorlagen.

Sie können mit GFM eingezäunten Codeblöcken für JavaScript verwenden. Zum Beispiel:

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

Das Ergebnis sieht so aus:

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

Die Standard -GitHub -Seitensyntax -Hervorhebung wurde in _config.yml deaktiviert, um das Hervorheben mit Prism.js zu ermöglichen.

Beitragen

Fühlen Sie sich frei, Änderungen an den Vorlagendateien oder Dokumentdateien vorzunehmen. Die unterstützenden Dokumente befinden sich in ihren jeweiligen Verzeichnissen, und die API -Dokumente befinden sich im Verzeichnis _includes .

Weitere Informationen zum Beitrag zur Dokumentation finden Sie im Leitfaden der Mitwirkenden, einschließlich Informationen zu Übersetzungen.

Warum Jekyll anstelle einer ausdrücklichen Lösung verwenden?

Jekyll wird mit Github-Seiten eingebaut. Da wir bereits GitHub -Seiten verwenden, um die Website zu hosten, ist es sinnvoll, die von ihnen angebotenen Funktionen zu nutzen. Es geht darum, das richtige Tool für den richtigen Job unter den richtigen Umständen zu verwenden.