Hiki2yard
bundle gemで作られるdirectoryに，hikiからyard, wiki文書を作る環境を自動構築する．
動機
| link | wiki | doc |
|---|---|---|
| 動機 | why? | why? |
インストール
以下のコマンドでgemとしてinstall:
$ gem install hiki2yard
Usage
gemのdirectoryで
$ hiki2yard --init
と打ち込めば，自動的に環境を整備．
動作内容
- Rakefileをcopy
- .yardoptsファイルを作成
- hikisディレクトリーを作成
- wikiディレクトリーを作成
- Githubでwikiを作成してからgit clone ***.wiki.gitのほうが確実．
その後
- hikisに適当にファイルを作成，編集
- rake yardでdocumentsが自動生成される．
やり残し
- mathjax用のひな形との切り替え．
- gemspecは手動で残した．
- リンク作成をwikiとdocで自動生成したいな．．．
- hiki2latexによるtex文書の自動生成．
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/daddygongon/hiki2yard. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
License
The gem is available as open source under the terms of the MIT License.