创建者文档下载 - 创建者文档源代码下载

创建者文档

其他源码

下载

Roblox 创建者文档

该存储库包含 create.roblox.com/docs 上创建者文档的源代码。

注意：目前，存储库包含指南、教程、教育内容和引擎 API 参考。代码示例即将推出。

如果您不熟悉 GitHub 贡献流程，请参阅关于拉取请求和以下视频。

报告问题

如果您发现文档存在问题并且不想提交拉取请求，请通过在 Roblox 开发者论坛上报告来告知我们。

贡献指南

Roblox 创建者文档的任何补充都必须适应更大的整体。换句话说，即使是一篇全面、准确、写得好的博客文章或技术白皮书也可能在网站上没有立足之地。

一般来说，我们寻找符合我们现有标准并适用于各种体验和用例的内容。例如，我们更喜欢“构建用户界面”之类的页面，而不是“为赛车游戏创建车速表”之类的页面。考虑在 Roblox 开发者论坛上发布更专业的指南。

当您提交拉取请求以供审核时，您必须同意以下内容：

此贡献全部或部分由我创建，我有权根据此存储库的开源许可证条款提交它。
我理解并同意，此贡献及其记录是公开的，无限期维护，并且可以根据此存储库的开源许可证条款重新分发。
据我所知，所有提议的更改都是准确的。

小贡献

对于仅涉及单个文件的简单更改，请使用 GitHub 的基于 Web 的编辑器：

在content/en-us/中找到该文件，然后单击编辑此文件。
单击分叉此存储库。
进行更改并单击提交更改...。
为您的更改提供描述性提交消息，然后单击“建议更改” 。
确保基础存储库是Roblox/creator-docs并且基础分支是main 。确认您对更改感到满意，然后单击创建拉取请求。
最后，填写拉取请求描述中的详细信息，然后单击创建拉取请求。

更大的贡献

对于涉及多个文件的较大更改，我们推荐 github.dev，这是一个基于 Visual Studio Code 的功能更齐全的文本编辑器，可在浏览器中运行：

分叉存储库。
浏览您的 fork 时，按。打开 github.dev 的密钥。
在源代码管理菜单中，单击... >分支>创建分支...。
为分支命名并单击Switch to Branch 。
使用资源管理器菜单在content/en-us中查找要更新的文件，然后进行所需的更改。
在“源代码管理”菜单中，验证您对所做的更改是否满意。
添加提交消息并单击Commit & Push 。
在新的浏览器选项卡中，导航至 github.com/Roblox/creator-docs。
单击“比较并拉取请求” 。
验证基础存储库是Roblox/creator-docs并且基础分支是main 。头存储库应该是您的分支和分支。
最后，填写拉取请求描述中的详细信息，然后单击创建拉取请求。

或者，您可以使用 github.dev 中的GitHub或GitHub Pull Request菜单提交拉取请求。有关使用 github.dev 的文档，请参阅 GitHub Codespaces。

离线工作流程

该存储库非常大，因此我们建议尽可能使用在线选项。但是，如果您已经熟悉一般 GitHub 工作流程并且想要使用离线文本编辑器，则以下是贡献文档的基本步骤：

设置 Git 和 Git LFS。或者，安装 Git 客户端，例如 GitHub Desktop。
分叉这个存储库。
克隆你的叉子。
导航到存储库根目录。
创建一个新分支。
进行您想要的更改。
提交，推送到您的分支，然后针对此存储库的main分支提交拉取请求。

有关更详细的步骤，请参阅 CONTRIBUTING.md。

文件类型

Roblox 文档具有三种主要文档类型：

content/en-us/ 中.md文件中的概念和基于任务的指南
指南会向您介绍某个功能或工作流程，但不会对最终结果做出过多规定。它们介绍了概念和功能，并涵盖了您可以使用各种工具或其他方法完成的任务。
指南从实际的、真实的用例、图像、代码片段和图表中受益匪浅。大多数基于任务的内容应包含编号列表。
content/en-us/reference 中.yaml文件中的 API 参考文档
API 完全是参考内容，应使用功能描述，并在适当的情况下链接到指南。与其他内容类型相比，参考内容应该简洁、直接；属性、方法、事件和回调的摘要不需要是完整的句子。
content/en-us/tutorials 中的.md文件中的教程
与基于任务的指南相比，教程更加独立，可以带您从无到有。这种对创建特定内容的关注意味着它们通常比指南更具规范性。教程通常会同时涉及多个功能和概念，展示工具和策略之间的联系。

如果您的贡献不属于这些类别或涵盖特别狭窄的主题，则它可能不太适合文档。考虑将其发布到 Roblox 开发者论坛。

贡献基础知识

尝试将您的编辑限制为一个类或功能，以便拉取请求更容易审查。错误修复和较小的改进更有可能获得快速批准。大型指南在出版前通常需要进行大量的反复讨论。

为了避免格式问题，我们建议使用 github.dev 等文本编辑器，让您在编写 Markdown 时预览。对于散文，请尝试遵循 STYLE.md 中的指南。对于代码示例，请使用 Lua 样式指南。

要查看完全按照我们在main分支上看到的内容格式化的页面，请替换content/及之前的整个 URL。具有基本名称index的文件应删除该名称。例如，“https://github.com/Roblox/creator-docs/blob/main/content/en-us/avatar/index.md”的页面呈现在“https://create.roblox.com” /docs/en-us/头像”。