如何为 Ruby gem 包使用 README.org 而不是 README.md

Question

现在，我正在尝试创建一个 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 会引发错误。

Answer 1

我的猜测是，问题出在

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

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

关于在您的 gem 文档中包含 README.org，您可以使用 "extra_rdoc_files"、

来实现

spec.extra_rdoc_files = ['README.org']

Answer 2

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

如何为 Ruby gem 包使用 README.org 而不是 README.md

How to use README.org instead of README.md for Ruby gem package

ruby

rubygems

org-mode

bundler