今、私はRuby gemを作成しようとしています。 bundle gem a_pkg_name
によって生成されたgemテンプレートを使用します。 "README.md"が自動的に作成され、デフォルトでgemのドキュメントとして使用されます。 README.md(markdown document)の代わりにREADME.org(emacsのorg-modeドキュメント)を使用できますか? 私はGitHubが "README"ファイルをサポートしており、README.mdが存在しなければREADME.orgが表示されることを知っています。ただし、gemの場合、rake build
はREADME.mdが存在しない場合はエラーを呼び出します。README.mdの代わりにREADME.mdをRuby gemパッケージに使用する方法
0
A
答えて
1
私の推測では、あなたがエラーを取り払うますGitのリポジトリに変更をコミットし、README.mdを削除した後に問題が
spec.files = `git ls-files -z`.split("\x0")
にある、あります。
そして、あなたの宝石のドキュメントにREADME.orgを含めて約
は、あなたがspec.extra_rdoc_files = ['README.org']
+0
完全で正確な返信をありがとう!私は私の宝石に "README.md"の代わりに "README.org"を追加することができました。 しかし、残念ながら、ヤードはemacsのorg-modeフォーマットの解析をサポートしていません。 – elgoog
2
ヤード0.9.10は現在、ORG-ルビーを使用して組織モードをサポートして、 "extra_rdoc_files" を使って、それを達成することができます。 https://github.com/lsegal/yard/pull/1133
関連する問題
- 1. README.mdでautotoolsを使用
- 2. デフォルトでREADME.mdファイルにgithub flavored markdownを使用する方法は?
- 3. NetBeansのMAVENプロジェクト用のREADME.md
- 4. ページの先頭にreadme.mdを配置する方法
- 5. オーディオをGithubに追加するreadme.md
- 6. HTMLコードをGithubのREADME.mdに添付
- 7. webpack + octicons:package.jsonの "main": "readme.md"の扱い方/無視方法
- 8. README.mdのGitHubページURLへの自動リンク?
- 9. Github:同期/プルを避けるREADME.md
- 10. GithubのREADME.mdファイルにテーブルを表示するには?
- 11. Githubの相対パスを使用したリンクREADME.md
- 12. GitlabでのGitlab変数の使用SonarQubeバッジのREADME.md
- 13. emacs ruby-modeの代わりにタブを使う方法は?
- 14. rails3のGemの代わりにプラグインを使用
- 15. Github Graphql APIからReadme.MDを入手するには?
- 16. ビデオをREADME.mdにvscodeの拡張子を挿入します
- 17. Ruby on Rails Zeus Windowsの代わりに?
- 18. 代わりにEditTextを使用する方法オートコンプリート用のフラグメント?
- 19. gitubのREADME.mdの中にPDFプロットを追加
- 20. GithubにはREADME.mdにmdファイルが含まれていますか?
- 21. Ruby on Railsでポリモーフィズムを使用する代わりに
- 22. Ruby ActiveSupport :: Concernでクラス変数を使用する代わりに
- 23. WordPressプラグインのリストを使って既存のREADME.mdを動的に更新する方法は?
- 24. githubのファイル名にスペースを含むファイルへのリンクREADME.md
- 25. Spring-integration-aws - Readme.mdが正しくありませんか?
- 26. androidListviewのCheckedTextViewの代わりにLinearLayoutを使用する方法
- 27. Spring Security:FilterInvocationの代わりにMethodInvocationを使用する方法
- 28. SyncEngineの代わりにAsyncHttpを使用する方法は?
- 29. ボタンの代わりにEnterを使用する方法JTextArea?
- 30. key_nameの代わりにdatastore idを使用する方法は?
@teksisto入力ミスを修正していただきありがとうございます。 – elgoog