ITADN
nodejs/nodejs.org
README.md
以下内容由 AI 翻译,如有问题请点此提交 issue 反馈


使用 Next.js、TypeScript、CSS Modules/Tailwind 和 MDXv3 构建的 Node.js 网站

MIT License Crowdin Badge Powered by Vercel
Build and Analysis Checks nodejs.org scorecard badge

这是什么仓库?

Nodejs.org,由 OpenJS Foundation 维护,是 Node.js® JavaScript 运行时的官方网站。本仓库是该网站的源代码。它使用 Next.js(一个 React 框架)构建。

pnpm install --frozen-lockfile
pnpm dev

# Listening at http://localhost:3000

贡献

本项目采用 Node.js [行为准则][]。

欢迎任何希望为本网站做出贡献的人!请阅读[贡献指南][]并查看[Figma 设计][],以更好地了解此仓库的结构。

[!IMPORTANT]
在为网站的翻译和本地化做出贡献之前,请先阅读我们的[翻译指南][]

[!NOTE]
我们建议在修改代码之前阅读以下所有相关链接;包括依赖项更改、内容更改和代码更改。

部署

main 分支发生新的推送时,网站会通过其 GitHub App 集成自动部署到 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/ 的代码库或相关基础设施。

这些内容在不同的仓库中维护,我们敦促用户在各自的仓库中提交 issue,以报告 bug、提出功能请求或处理与这些端点相关的任何事宜。

  • release-cloudflare-worker: 负责提供上述链接中提到的 Node.js 发行版二进制文件、API 文档及其他资产的代码库。
    • 我们使用 Cloudflare R2 Buckets 存储我们的资产,并使用 Cloudflare Workers 向 Web 提供这些资产。
  • node/doc/api: 我们 API 文档的源代码,包含所有 Node.js API 文档 Markdown 文件
  • doc-kit: 构建和编译我们 API 文档的工具。还负责生成访问 https://nodejs.org/api/ 时您看到的内容。

相关链接

Code of Conduct

Contribution Guidelines

Collaborator Guide

Governance Document

Figma Design

Content vs Code

Dependency Pinning

Translation Guidelines

Status Page of the Node.js web infrastructure.

致谢

  • 感谢所有让本项目成为可能的贡献者和协作者。
  • 感谢 Chromatic 提供可视化测试平台,帮助我们审查 UI 变更并捕获视觉回归。
  • 感谢 Vercel 提供托管并驱动 Node.js 网站的基础设施
  • 感谢 Cloudflare 提供托管 Node.js 网站、Node.js CDN 及其他服务的基础设施。
    • 特别向 Cloudflare 致以诚挚的感谢,没有他们的巨大支持,我们将无法为我们的社区提供服务。
  • 感谢 Sentry 为其错误报告、监控和诊断工具提供开源许可。
  • 感谢 Crowdin 提供一个平台,让我们能够本地化 Node.js 网站并与翻译者协作。
  • 感谢 Orama 提供一个搜索平台,索引我们广泛的内容,并为用户提供极速结果。
  • 感谢 DigitalOcean 作为其开源计划的一部分,慷慨地为 Node.js 提供额度。