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 提供了一个搜索平台，可以对我们广泛的内容进行索引，并为我们的用户提供闪电般快速的结果。