ruby-list

Download

ruby-list@ml.ruby-lang.org

July 2026

1 participants
1 discussions

[ruby-list:51037] るりま(Ruby リファレンスマニュアル)のソースを Markdownに移行しました
by Kazuhiro NISHIYAMA 24 Jul '26

24 Jul '26

るりま(Ruby の日本語リファレンスマニュアル)の開発に参加している西山和広です。 2026年7月に、るりまのドキュメントソースを従来の RD ベースの独自記法 (RRD)から GitHub Flavored Markdown ベースの記法へ移行しましたのでお知らせします。本番切替は完了しており、現在の https://docs.ruby-lang.org/ja/ は Markdown ソースからビルドした HTML を配信しています。読む側に大きな変化はありません(URL・ページ構成は従来どおりです)。変わったのは書く側で、主な変更点は次のとおりです。 * ドキュメントの編集場所が rurema/doctree リポジトリの manual/ 配下の .md ファイルに変わりました。各ページ下部の編集リンクから該当ファイルに直接飛べます。 https://github.com/rurema/doctree * 旧 refm/ ツリーは凍結中です。編集しても公開サイトには反映されませんのでご注意ください(移行期間の後に削除予定)。 * バージョン分岐(#@since / #@until)の仕組みは従来どおりです。 * あわせて検索ページを静的検索に置き換え、Ruby 1.8.7〜2.7.0 の旧バージョンも検索対象に復活しました。 https://docs.ruby-lang.org/ja/search/ * 読む側の改善として、Ruby 3.2 以降の各バージョンのページでは、コード例をブラウザ内でそのまま実行できる RUN ボタンが使えるようになりました(ruby.wasm によるクライアントサイド実行です)。ほかにも、メソッド見出しへの対応バージョンのバッジ表示(「Ruby 3.2 から」など)、ページタイトルへの別名 (collect と map など)の併記、defined? などの言語キーワードでの検索対応、といった改善が入っています。 * Ruby 4.0 以降のページでは、モジュール関数の表記が従来の Math.#atan2 形式から、RBS の def self?.bar 記法に似せた Math?.atan2 形式に変わりました(3.4 以前のページは従来どおりです。検索はどちらの表記でもヒットします)。 * あわせて、2014 年から溜まっていた doctree の open issue 181 件を全件棚卸しし、説明の誤りを現在の Ruby で実測しながらまとめて修正しました。残っているのは方針検討中の数件のみです。移行の経緯や記法の詳細は、以下にまとめてあります。 * 紹介記事(ブログ): https://blog.n-z.jp/blog/2026-07-23-rurema-to-markdown * 記法仕様: https://github.com/rurema/bitclust/blob/master/doc/markdown-samples/MARKUP_… * 移行の背景・FAQ: https://github.com/rurema/bitclust/blob/master/doc/markdown-announcement.md * 貢献の手引き: https://github.com/rurema/doctree/blob/master/CONTRIBUTING.md Markdown になったことで、ドキュメント修正の敷居はだいぶ下がったと思います。誤字の修正から新しいメソッドの説明の追加まで、PR をお待ちしています。 -- |ZnZ(ゼットエヌゼット) |西山和広(Kazuhiro NISHIYAMA)

1 0