るりま書く

つかいかた

$ rake setup
$ bundle exec guard

上記のguardを実行したあと、 http://localhost:9292/ を開いておきます。

るりまのドキュメントはdoctree/refm/api/srcディレクトリの下にあります。この中のファイルを編集(メソッドの説明を変更、コード例を追記など)して保存するとブラウザが自動でリロードされ、編集中のるりまのプレビューが表示されます。表示されるのは最後に更新したファイルです。

いい感じにかけたらdoctreeディレクトリの下に移動して変更をコミットしPull Requestを送りましょう。

  1. https://github.com/rurema/doctree をfork
  2. doctree ディレクトリ以下に移動、変更をコミット
    $ cd doctree
    $ git checkout -b your_change
    $ git add .
    $ git commit
    
  3. 1でforkしたリポジトリをremoteに追加
    $ git remote add yourname https://github.com/yourname/doctree
    
  4. リポジトリに変更をpush
    $ git push yourname HEAD
    
  5. https://github.com/rurema/doctree でPull Requestを作成

ほしいきのう

特にローカルマシンでセットアップせずにブラウザからコントリビュートできる機能

ドキュメントがまだ書かれていないエントリなど、どれを書けばいいかわかる機能

参考: https://github.com/hanachin/rurema-scripts