Docs header transparent bg

编写手册页文档

本文档中的所有命令或文件路径都假设您位于 rubygems/rubygems 仓库的 bundler/ 目录中

Bundler 用户的主要帮助来源是手册页:运行 bundle help(或 bundler help)时打印的输出。这些页面可能在格式和预览方面有点棘手,但一旦你掌握了窍门,就非常简单了。

注意:bundlerbundle 在 CLI 中可以互换使用。本指南使用 bundle,因为它更可爱。

手册页包含什么内容?

我们使用手册页来记录 Bundler 在 CLI(命令行界面)中使用的命令。它们的长度可能从很长(参见 bundle install)到非常短(参见 bundle clean)不等。

要查看 Bundler CLI 中可用的命令列表,请键入

  $ bundle help

我们的目标是为每个命令提供一个手册页。

没有找到某个命令的手册页?创建一个新页面并向我们发送 PR!我们也欢迎对现有页面的编辑。

创建新的手册页

要创建新的手册页,只需在 lib/bundler/man/ 目录中创建一个新的 .ronn 文件。

例如:要为 bundle cookies 命令(遗憾的是,这不是一个真实命令)创建一个手册页,我会创建一个名为 lib/bundler/man/bundle-cookies.1.ronn 的文件,并在其中添加我的文档。

格式

我们的手册页使用 ronn 格式,它结合了 Markdown 和标准手册页约定。刚开始可能有点奇怪,尤其是如果你经常使用 Markdown 的话。

ronn 指南格式指南 提供了对常见格式类型的良好概述。

一般来说,让你的页面看起来像其他页面:使用 ##OPTIONS 等部分,并在适当的地方使用代码块和定义列表等格式。

如果你不确定格式是否正确,没关系!用你现有的内容创建一个拉取请求,我们会看一下。

预览

要预览你的更改,使其与 Bundler 用户打印出来一样,你需要运行一系列命令

$ rake spec:deps $ rake man:build $ man ./lib/bundler/man/bundle-cookies.1

如果你对 bundle-cookies.1.ronn 做了更多更改,你需要在预览之前再次运行 rake man:build

测试

我们对文档进行了测试!在你创建拉取请求之前,最重要的测试文件是 help 命令的测试文件,以及另一个用于文档质量的测试文件。

$ bin/rspec ./spec/commands/help_spec.rb $ bin/rspec ./spec/quality_spec.rb

Bundler 文档网站 编写文档

如果你想为 Bundler 文档网站 上的任何主要命令或实用程序提交拉取请求,请按照上面关于从 rubygems/rubygems 存储库编写 man 页面文档的说明操作。它们在每种情况下都是相同的。

注意:编辑 rubygems/rubygems 存储库中用于主要命令和实用程序文档的 .ronn 文件就足够了 🎉。无需手动更改 rubygems/bundler-site 存储库中的任何内容,因为 man 页面和 Bundler 文档网站 上主要命令和实用程序的文档是一致的。它们是通过 rake man:build 命令从 rubygems/rubygems 存储库的 .ronn 文件自动生成的。

此外,如果你想添加指南或教程:在 rubygems/bundler-site 存储库中,转到 /bundler-site/source/current_version_of_bundler/guides 并添加 一个新的 Markdown 文件(扩展名以 .md 结尾)。确保正确格式化新指南的标题,如下所示: --- title: RubyGems.org SSL/TLS Troubleshooting Guide ---

在 GitHub 上编辑此文档,如果您发现错误或遗漏。