nodejs.org

Node.js-Website, erstellt mit Next.js mit TypeScript, CSS-Modulen/Tailwind und MDXv3

Was ist das für ein Repo?

Nodejs.org von der OpenJS Foundation ist die offizielle Website für die Node.js® JavaScript-Laufzeitumgebung. Dieses Repo ist der Quellcode für die Website. Es wird mit Next.js, einem React Framework, erstellt.

npm ci
npm run dev

# listening at localhost:3000 

Mitwirken

Dieses Projekt übernimmt den Verhaltenskodex von Node.js.

Jeder, der zur Website beitragen möchte, ist willkommen! Bitte lesen Sie die Beitragsrichtlinien und sehen Sie sich das Figma-Design an, um die Struktur dieses Repositorys besser zu verstehen.

Wichtig

Bitte lesen Sie unsere Übersetzungsrichtlinien, bevor Sie an der Übersetzung und Lokalisierung der Website mitwirken

Notiz

Wir empfehlen, alle unten aufgeführten relevanten Links zu lesen, bevor Sie Codeänderungen vornehmen. Einschließlich Abhängigkeitsänderungen, Inhaltsänderungen und Codeänderungen.

Einsatz

Die Website wird über die GitHub-App-Integration automatisch auf Vercel bereitgestellt, wenn neue Pushs im main stattfinden.

Einzelheiten zur Bereitstellung sind aufgrund bestimmter Einschränkungen nur den Betreuern des Website-Teams zugänglich.

Die aktuelle Integration ist Eigentum der OpenJS Foundation und wird vom Website-Team verwaltet.

Legacy-Bereitstellung

Das vollständige Setup finden Sie unter https://github.com/nodejs/build/tree/master/ansible/www-standalone abzüglich Geheimnisse und Zertifikate.

Der Webhook wird für dieses Projekt auf GitHub eingerichtet und kommuniziert mit einem kleinen Node-Server auf dem Host, der die Arbeit erledigt. Sehen Sie sich dazu das Paket github-webhook an.

Node.js-Binärdateien und API-Dokumente

Dieses Repository enthält nicht die Codebasis oder zugehörige Infrastruktur, die https://nodejs.org/api/ , https://nodejs.org/docs/ oder https://nodejs.org/dist/ bedient.

Diese werden in verschiedenen Repositorys verwaltet und wir bitten Benutzer dringend , Probleme in ihren jeweiligen Repositorys zu öffnen, für Fehlerberichte, Funktionsanfragen oder andere Angelegenheiten im Zusammenhang mit diesen Endpunkten.

• release-cloudflare-worker : Die Codebasis, die für die Bereitstellung der Node.js-Verteilungsbinärdateien, API-Dokumente und aller anderen Assets über die oben genannten Links verantwortlich ist.
  • Wir verwenden Cloudflare R2 Buckets zum Speichern unserer Assets und Cloudflare Worker zum Bereitstellen dieser Assets im Web.
• node/doc/api : Der Quellcode unserer API-Dokumente. Er enthält alle Node.js-API-Dokumentations-Markdown-Dateien
  • node/doc enthält die HTML-Vorlagen, CSS-Stile und den JavaScript-Code, der auf der Clientseite unserer von API Docs generierten Seiten ausgeführt wird.
  • node/tools/doc enthält die Tools, die unsere API-Dokumente validieren, linten, erstellen und kompilieren. Auch verantwortlich für die Generierung dessen, was Sie sehen, wenn Sie auf https://nodejs.org/api/ zugreifen.

Relevante Links

Verhaltenskodex

Beitragsrichtlinien

Leitfaden für Mitarbeiter

Figma-Design

Inhalt vs. Code

Abhängigkeitspinning

Übersetzungsrichtlinien

Statusseite der Node.js-Webinfrastruktur.

Danke

• Vielen Dank an alle Mitwirkenden und Mitarbeiter, die dieses Projekt möglich machen.
• Vielen Dank an Chromatic für die Bereitstellung der visuellen Testplattform, die uns hilft, Änderungen an der Benutzeroberfläche zu überprüfen und visuelle Regressionen zu erkennen.
• Vielen Dank an Vercel für die Bereitstellung der Infrastruktur, die die Node.js-Website bedient und betreibt
• Vielen Dank an Cloudflare für die Bereitstellung der Infrastruktur, die die Website von Node.js, das CDN von Node.js und mehr bedient.
  • Ein wirklich herzliches Dankeschön an Cloudflare, da wir ohne ihre immense Unterstützung nicht in der Lage wären, unserer Community zu dienen.
• Vielen Dank an Sentry für die Bereitstellung einer Open-Source-Lizenz für ihre Fehlerberichts-, Überwachungs- und Diagnosetools.
• Vielen Dank an Crowdin für die Bereitstellung einer Plattform, die es uns ermöglicht, die Node.js-Website zu lokalisieren und mit Übersetzern zusammenzuarbeiten.
• Vielen Dank an Orama für die Bereitstellung einer Suchplattform, die unsere umfangreichen Inhalte indiziert und unseren Benutzern blitzschnelle Ergebnisse liefert.