跳至正文
版本：bleeding-edge 🩸

🤝 为文档做出贡献

你好 Dyno！你好 Markdown！

本文档基于 Docusaurus 平台制作，并使用 Markdown 编写！请随时在 GitHub 上提出修改建议和编辑页面，这些帮助对我们至关重要，我们衷心感谢每一位参与文档编写的人！

提出修改建议​

你可以直接在 GitHub 上提出修改建议，只需点击每个页面左下角的 编辑此页面 按钮，提出你的建议并为此开启一个拉取请求即可！一旦被接受，你的建议将立即应用到文档的 bleeding-edge 版本中！

本地运行文档​

要在打开拉取请求之前预览你的更改，请克隆 docs 仓库 及其子模块（API 是一个子模块），然后使用 Node.js 和 Yarn 运行它：

Terminal
git clone --recurse-submodules https://github.com/nanos-world/docs.git
cd docs
yarn install
yarn start

文档将在 http://localhost:3000 打开，并在你编辑文件时重新加载。

在哪编辑​

  • docs/ 是文档的 bleeding-edge 版本，与最新的游戏更新相匹配。大部分更改应该在这里进行。
  • versioned_docs/version-latest/ 是稳定版。仅用于修复当前稳定版游戏版本中也存在的问题。
  • blog/ 包含新闻文章。
  • src/api/ 是一个包含 API JSON 文件的子模块（见下文）。

写作提示​

  • 每个标题都以明确的锚点结尾，例如 ## My Heading {/* #my-heading */}，这样链接在翻译后的页面中仍然有效。运行 yarn write-heading-ids 来生成它们。
  • 使用文件路径链接到其他页面，例如 [包指南](/core-concepts/packages/packages-guide.mdx)。
  • 使用内置组件来引用 API，例如 <Classes.Character /> , <StaticClasses.Server /> , <MethodReference type="Class" class_name="Actor" method_name="SetLocation" /> 和 <EventReference type="Class" class_name="Character" event="Death" /> 。
  • 在 Lua 代码块的标题中添加服务器位置信息（例如 ```lua title="Server/Index.lua"），这有助于读者了解代码的运行位置。

API 参考​

我们的文档非常智能！脚本参考部分是基于我们在 GitHub 上的 JSON API 仓库自动生成的。我们已将所有的类、方法和事件定义为 JSON 格式，它可以被解析为任何格式！

因此，如果你想对在那里发现的任何描述或拼写错误提出修改建议，请参考我们 API 仓库的对应文件夹：Classes、StaticClasses、Structs、UtilityClasses、StandardLibraries 或 Enums！

翻译页面​

默认情况下，GitHub 上的所有页面均为英文，所有翻译均由 Crowdin 提供。你可以访问 nanos world 官方文档 Crowdin 页面，帮助我们完成所有可用语言的翻译！你也可以申请支持更多语言！如果你想协助翻译一种新的语言，请联系我们！

Crowdin