如何在 Ruby gem 包中使用 README.org 而不是 README.md答案

【问题标题】：How to use README.org instead of README.md for Ruby gem package如何在 Ruby gem 包中使用 README.org 而不是 README.md
【发布时间】：2017-11-21 00:39:27
【问题描述】：

现在，我正在尝试创建一个 Ruby gem。我使用bundle gem a_pkg_name生成的gem模板。然后，“README.md”会自动创建并默认用作 gem 的文档。我可以使用 README.org（emacs org-mode 文档）而不是 README.md（markdown 文档）吗？我知道 GitHub 支持“README”文件，如果 README.md 不存在，则会显示 README.org。但是，对于 gem，如果 README.md 不存在，rake build 会调用错误。

【问题讨论】：

@teksisto 感谢您纠正我的错字。

标签： ruby rubygems bundler org-mode

【解决方案1】：

我的猜测是，问题出在

spec.files         = `git ls-files -z`.split("\x0")

删除 README.md 后，将更改提交到 git repo 将消除错误。

关于在您的 gem 文档中包含 README.org，您可以通过使用“extra_rdoc_files”来实现，

spec.extra_rdoc_files = ['README.org']

【讨论】：

感谢您完整准确的回答！我可以在我的 gem 中添加“README.org”而不是“README.md”。但是，不幸的是，yard 不支持解析 emacs org-mode 格式..

【解决方案2】：

Yard 0.9.10 现在支持使用 org-ruby 的 org-mode。 https://github.com/lsegal/yard/pull/1133

【讨论】：