website metalsmith

Fastify-Websit

Warnung :
Dieses Repository war bis Juni 2023 die vorherige Heimat der Fastify -Website.
Das neue Zuhause ist jetzt fastify/website-next

Dieses Projekt wird verwendet, um die Website für Fastify Web Framework zu erstellen und online zu veröffentlichen.

Anforderungen

• Knoten 12+
• Installieren Sie Abhängigkeiten mit npm install

Bauen

Um den Aufbau der Website auszulösen, müssen Sie nur ausführen:

npm run build

Dadurch werden alle für die Erstellung eines Builds erforderlichen Schritte ausgeführt (statische Website).

Wenn Sie sich entwickeln, können Sie ausführen:

npm start

Dadurch wird der Build ausgelöst und startet auch einen Live -Server, auf dem Sie die Änderungen, die Sie auf der Website durchführen, visualisieren können.

(Beachten Sie, dass Sie jedes Mal, wenn Sie eine Änderung der Vermögenswerte vornehmen, die den Inhalt der Website ausmachen npm run build:website starten, um einen Umbau auszulösen.)

Schritte erstellen

Falls Sie mehr darüber erfahren möchten, wie der Build -Prozess funktioniert, sind hier die Hauptschritte, die während seiner Ausführung durchgeführt werden:

1. Reinigung : Entfernt temporäre Ressourcen, die möglicherweise aus einem früheren Build erstellt wurden
2. Erstellung von TEMP -Ordnern : Erstellt die erforderlichen Ordner für den Build -Prozess
3. Releases erhalten : Verwendet die Github -APIs, um die neuesten Veröffentlichungen von Fastify herunterzuladen, damit die Dokumentationsseiten dynamisch regeneriert werden können.
4. Prozessfreisetzungen : Verarbeitet die Freisetzungen, die alle erforderlichen dynamischen Dateien erstellen, die von den ursprünglichen Fastify -Releases abgeleitet werden (hauptsächlich zum Generieren und Prozessdokumentationsseiten)
5. Website -Generierung : verwendet Metalsmith, um eine statische Version der Website zu kompilieren.

Schauen Sie sich die Paketskripte an, um zu verstehen, welche Dateien diese Aktionen auslösen, falls Sie sich den Code für eine der oben beschriebenen Schritte ansehen möchten.

Veröffentlichung als Github -Seiten

Die Website wird automatisch CIR CIR CIR mit GitHub-Seiten (Zweig gh-pages ) veröffentlicht.

Jedes Mal, wenn der Master eine Änderung vorliegt und der Build erfolgreich erstellt wurde, wird er automatisch auf Github -Seiten veröffentlicht.

Damit dies funktioniert, muss Circle CI korrekt konfiguriert werden, um alle erforderlichen Umgebungsvariablen bereitzustellen:

• DOMAIN : Die benutzerdefinierte Domäne, die auf Github -Seiten verwendet werden soll ( www.fastify.io )
• GH_EMAIL : Die E-Mail des in gh-pages autorisierten Github-Benutzer
• GH_NAME : Der Benutzername des in Circleci autorisierten gh-pages -Benutzer
• GH_TOKEN : (optional) Ein persönliches GitHub -Token für den in GH_NAME angegebenen Benutzer. Wenn dies vorhanden ist, wird die API -Aufrufe bei GitHub authentifiziert.
• CLOUDFLARE_EMAIL : Die E -Mail des Cloudflare -Kontos
• CLOUDFLARE_AUTH_KEY : Der Autorisierungsschlüssel zur Ausführung von API -Aufrufen von Cloudflare -APIs
• CLOUDFLARE_ZONE : Die ID der Cloudflare -Zone, die der aktuellen Domäne zugeordnet ist

Beitragen

Jeder ist sehr willkommen, um zu diesem Projekt beizutragen. Sie können nur einen Beitrag leisten, indem Sie Fehler einreichen oder Verbesserungen vorschlagen, indem Sie ein Problem eröffnen oder eine Pull -Anfrage senden.

Lizenz

Lizenziert unter MIT -Lizenz. © OpenJS Foundation und das Fastify -Team.