关于如何开始为古腾堡项目贡献文档的指南。
这个制作WordPress文档博客是WordPress文档最新信息的主要来源，包括公告、产品目标、会议笔记、会议议程等。
文档的实时讨论在#文档通道输入使WordPress松弛（需要注册）。文档团队的每周会议在星期二14:00UTC举行。
古腾堡项目使用GitHub管理代码和跟踪问题。主存储库位于：https://github.com/WordPress/gutenberg网站。要查找要处理的文档问题，请浏览文档标签问题.
古腾堡项目有两套主要文件：
- 用户文档是关于如何将编辑器用作作者发布文章的信息。对于用户文档的贡献，请关注文档博客或在#docs Slack频道中询问，以了解当前的优先级。
- 块编辑器手册是与古腾堡项目相关的一切，包括：开发、扩展，以及你现在正在阅读的对古腾堡的贡献。
本文档的其余部分涵盖了对块编辑器手册的贡献。
块编辑器手册混合了/文档/目录古腾堡项目储存库并从包中生成文档。
自动作业每隔15分钟将文档发布到块编辑器手册网站.
请参见Git工作流有关如何使用git通过pull请求部署更改的文档。此外，请参阅视频演练和随行人员为古腾堡贡献文档的幻灯片.
该手册根据文件的功能类型分为四个部分。文件系统很好地解释了每种类型的需求和功能，但简而言之，它们是：
- 入门教程–完整的课程，让学员逐步完成目标，例如创建块教程.
- 操作指南–例如，针对完成小型特定任务的简短课程如何将按钮添加到块工具栏.
- 参考指南–API文档，纯功能描述，
- 解释–较长的文档侧重于学习，而不是特定任务。
一操作指南模板可为指南提供通用结构。如果要开始新的操作指南，请从模板复制标记以开始。
该模板基于The Good Docs Project中的示例。查看他们的模板存储库有关其他示例，以帮助您创建高质量文档。
要更新现有页面：
- 查看古腾堡知识库。
- 例如，创建要工作的分支
docs/更新contrib指南.
- 对现有文档进行必要的更改。
- 提交您的更改。
- 使用[类型]开发人员文档标签。
要添加新文档，需要一个工作的JavaScript开发环境来构建文档，请参阅JavaScript构建设置文档:
- 在中创建标记文件文档文件夹，使用小写，无空格，如果需要，使用破折号分隔符，以及
.md文件扩展。
- 使用降价符号添加内容。所有文件只需要一个
小时1标签。
- 将文档条目添加到toc.json公司等级制度。有关格式，请参阅现有条目。
- 运行
npm运行文档：生成要更新宣言.json.
- 提交
宣言.json更新了其他文件。
如果你忘记跑步，npm运行文档：构建您的公关将无法通过静态分析检查，因为宣言.json文件是必须提交的未提交本地更改。
通过提取位于包根目录中的README.md文件的内容，文档工具会自动生成包文档。然而，有时最好将自述文件的内容分成更小、更容易阅读的部分。
这可以通过创建文档包中的目录并添加toc.json公司包含引用其他降价文件的文件也包含在文档目录。这个toc.json公司文件应该包含一个页面数组，作为主README文件的子页面添加。格式遵循宣言.json自动生成的文件。
为了将这些页面嵌套在主包名称下，请确保将起源属性正确。请参阅下面的示例，该示例将子页面添加到@wordpress/创建块部分.
[{“title”：“@wordpress/create-block外部模板”，“slug”：“packages-create-block-external-template”，“markdown_source”：“../packages/create-block/docs/external-template.md”，“父”：“包创建块”}]
在某些时候，您可能会希望链接到其他内部文档页面。值得强调的是，所有文档都可以在不同的上下文中浏览：
要创建在所有上下文中都有效的链接，必须使用不带`https://github.com/WordPress/gutenberg网站`前缀。您可以使用以下模式引用文件：
/docs/*.md/软件包/*/README.md/包/组件/src/**/README.md
这样，它们将在上述所有三种上下文中得到正确处理。
使用Gutenberg存储库中的完整目录和文件名，而不是发布的路径；《块编辑器手册》创建了简短的URL，您可以在教程部分中看到这一点。同样自述.md该部分已在手册中删除，但应包含在链接中。
例如，指向此页面的链接是：/文档/贡献者/文档/README.md
注：通常的链接转换不应用于标注中的链接。请参见下文。
标记中的代码示例应该用三个勾号“`”包装，并且还应该包括一个语言说明符。看看这个围绕隔离代码块的GitHub文档.
古腾堡文档的一个独特功能是代码标签切换，这允许同时显示两个版本的代码。这用于显示两者JSX公司和普通代码示例。
下面是一个示例代码标签部分：
\{\%codetabs\%\}\{\%JSX\%\}```js公司//此处为JSX代码```\{\%普通\%\}```js型//此处为普通代码```\｛\%end\%\｝
代码示例的首选格式是JSX。这应该是默认视图。在源代码中放在第一位的示例将显示为默认值。
注：不需要在每个指南中都包含纯JavaScript代码示例。建议包括初学者教程或简短示例的普通代码，但Gutenberg包中以及更大的React和JavaScript生态系统中的大多数代码都在JSX中，需要构建过程。
块编辑器手册也支持注意其他WordPress手册的风格然而，对于块编辑器手册文档发布的不同位置（npm、GitHub），短代码实现并不理想。
建议在标记中实现的方法是使用原始HTML和详图索引标高类。例如：
<div class=“callout callout-info”>这是一个**info**callout</div（分频）>
以下类别可用：信息,提示,警觉的,警告
这是一个**提示**标注。
这是一个**info**标注。
这是一个**警报**标注。
这是一个**警告**标注。
您应该将编辑器配置为使用Prettier自动形成降价文档。请参阅入门文档了解完整的详细信息。
使用Visual Studio代码和Prettier扩展的示例配置：
“[[降价]]”：{“editor.defaultFormatter”：“esbenp.prettier-vscode”，“editor.formatOnSave”：true},
根据您查看此文档的位置，括号可能显示为双括号。正确的格式只是一个括号。
块编辑器手册中的视频需要在WordPress YouTube频道作为未列出的视频。此过程需要其他权限。通过#marketing Slack渠道寻求帮助。
视频上传到YouTube后，检索视频嵌入链接。它应该看起来像这样：
https://www.youtube.com/embed/nrut8SfXA44？si=YxvmHmAoYx-BDCog公司
然后，将以下代码放在希望视频嵌入文档的位置。相应地更新嵌入链接和视频标题。
<iframe width=“960”height=“540”src=“[Video embed link]”title=“[Video title]”frameborder=“0”allow=“加速计；自动播放；剪贴板写入；加密媒体；陀螺仪；图片中的图片；网络共享”allowfullscreen=“true”></iframe>
视频的纵横比应为16:9以尽可能高的分辨率拍摄。