nodejs.org

使用 Next.js 與 TypeScript、CSS 模組/Tailwind 和 MDXv3 建構的 Node.js 網站

這個回購協議是什麼？

OpenJS 基金會的 Nodejs.org 是 Node.js® JavaScript 運行時的官方網站。該存儲庫是該網站的源代碼。它是使用 React 框架 Next.js 建構的。

npm ci
npm run dev

# listening at localhost:3000 

貢獻

此專案採用 Node.js 行為準則。

歡迎任何願意為網站做出貢獻的人！請閱讀貢獻指南並查看 Figma 設計，以更好地理解此儲存庫的結構。

重要的

在參與網站的翻譯和在地化之前，請閱讀我們的翻譯指南

筆記

我們建議在更改程式碼之前閱讀下面的所有相關連結；包括依賴項變更、內容變更、程式碼變更。

部署

當main分支上發生新推送時，網站會透過其 GitHub 應用程式整合自動部署到 Vercel。

由於某些限制，有關部署的詳細資訊只有網站團隊的維護人員才能存取。

目前整合由 OpenJS 基金會擁有並由網站團隊管理。

舊版部署

完整的設定位於 https://github.com/nodejs/build/tree/master/ansible/www-standalone 中，減去秘密和證書。

該專案在 GitHub 上設定了 Webhook，並與主機上的小型 Node 伺服器進行通信，並由該伺服器完成工作。請參閱 github-webhook 套件。

Node.js 二進位和 API 文件

此儲存庫不包含服務https://nodejs.org/api/ 、 https://nodejs.org/docs/或https://nodejs.org/dist/的程式碼庫或相關基礎架構。

它們維護在不同的儲存庫中，我們敦促使用者在各自的儲存庫中開啟問題，以獲取錯誤報告、功能請求或與這些端點相關的任何事項。

• release-cloudflare-worker ：負責提供 Node.js 分發二進位檔案、API 文件以及上述連結中的任何其他資產的程式碼庫。
  • 我們使用 Cloudflare R2 Buckets 來儲存我們的資產，並使用 Cloudflare Workers 將這些資產提供給 Web。
• node/doc/api ：我們的 API 文件的源代碼，它包含所有 Node.js API 文件 Markdown 文件
  • node/doc包含在我們的 API 文件產生的頁面的用戶端上執行的 HTML 範本、CSS 樣式和 JavaScript 程式碼。
  • node/tools/doc包含驗證、lints、建置和編譯我們的 API 文件的工具。也負責產生您在造訪https://nodejs.org/api/時看到的內容。

相關連結

行為守則

貢獻指南

合作者指南

Figma設計

內容與程式碼

依賴固定

翻譯指南

Node.js Web 基礎架構的狀態頁面。

謝謝

• 感謝所有使這個計畫成為可能的貢獻者和合作者。
• 感謝 Chromatic 提供了視覺測試平台，幫助我們審查 UI 變更並捕捉視覺回歸。
• 感謝 Vercel 提供為 Node.js 網站提供服務和支援的基礎設施
• 感謝 Cloudflare 提供了為 Node.js 網站、Node.js 的 CDN 等提供服務的基礎設施。
  • 衷心感謝 Cloudflare，如果沒有他們的大力支持，我們將無法為社區提供服務。
• 感謝 Sentry 為其錯誤報告、監控和診斷工具提供開源許可證。
• 感謝 Crowdin 提供了一個平台，使我們能夠在地化 Node.js 網站並與譯者合作。
• 感謝 Orama 提供了一個搜尋平台，為我們廣泛的內容建立索引，並為我們的用戶提供閃電般快速的結果。