NeoForged 开发文档

此仓库用于存放 NeoForge 开发文档，它包含了 NeoForge 开发文档与 NeoGradle 使用文档

此文档是一个非官方中文版本，如果你在找官方英文版本，请前往 https://github.com/neoforged/Documentation

此文档采用 Docusaurus 3 构建

贡献

你可以阅读如何为 NeoForged 开发文档作出贡献以了解如何为此文档作出贡献

如果你想要为这个文档提供帮助或作出一些贡献，你可以 fork 这个仓库，clone 到本地，作出修改后向此项目提交 PR

如果你发现这个非官方文档的翻译存在一些问题，但又不清楚如何提交 PR，你可以在这里提交一个 Issue 来告诉我

如果你想要为这个非官方文档的运营作出一些贡献，你可以往 mc19770214@outlook.com 这个邮箱发邮件

准备环境

此文档使用了 Node.js 18 作为其运行环境，如果你想要为此文档作出贡献，你需要提前配置好此环境 你可以手动安装它，或者使用一个支持 .node-version 文件或 .nvmrc 文件的 Node.js 版本管理器来安装它 对于常见的 Node.js 版本管理器，你可以使用 install 或 use 命令来安装正确的 Node.js 版本，例如:

nvm install # or 'nvs use'

预览，开发与调试

你可以运行下列命令以开启一个实时的网页开发服务器，方便你在本地预览你的修改版文档 大多数修改都会在你保存时被立即应用，你无需重启网页开发服务器便可以看到你修改后的文档（也即热重载功能）

npm install
npm run start

构建文档

如果你希望构建一个可部署的静态版本的文档，你可以通过下列命令来完成它:

npm run build

这条命令会在 build 文件夹内生成你的文档的静态资源，然后你便可以用这些静态资源去搭建公开给所有人看的文档了

致谢

下面是参与了这个项目的所有人，谢谢你们！

• BlueFunny: 项目创始人，负责翻译文档与 GitHub Pages 页面的维护