2019年12月08日

るりまのパンくずリスト

るりま (※) のパンくずリストのマークアップ方法について、これまでほぼプレーンテキストとして表現されていたのを、順序付きリストで表現するようにし、ついでにheader要素とnav要素で囲んでナビゲーションであることを表現するように変更した。

※るりまとは、https://docs.ruby-lang.org/ja/ で配信されている、プログラミング言語Rubyの日本語のリファレンスマニュアルの通称である。

<p>A &gt; B &gt; C &gt; D</p>

これまで上記のような感じだったのが、下記のような感じになる。

<header>
  <nav>
    <ol>
      <li>A</li>
      <li>B</li>
      <li>C</li>
      <li>D</li>
    </ol>
  </nav>
</header>

CDNでキャッシュされているので、もしかしたらまだ変更が反映されていないページが取得されるかもしれないけれど、しばらくしたら全てのページに変更が反映されると思う。

RubyのドキュメントをGoogleから検索したいときに、るりまが検索結果のより上位に表示されてくれると嬉しい。しかし、現状そうではないことがままある。そこで、マークアップ方法を改善してより良く構造化することで、利用者の利便性を向上するとともに、検索結果の上位に表示してもらうことを狙いたい。

より機械に優しいHTMLにすべく、パンくずリストの情報をJSON-LDでもマークアップしてはどうか、という変更も提案している。

他に、クラスのドキュメントページに記述する継承リストについても、パンくずリストで表現した方がより良くなるのではないか、というPull Requestも出している。