ITエンジニア/デザイナ向けにオープンソースを毎日紹介

HTMLは基本的には構造化されたドキュメントです。見出しや小見出しをHタグで定義することでクローラーやシステムにとっては構造化された文書であると判断できます。人間の目ではスタイルシートで自由に見た目を変更できてしまうので分かりづらいかも知れません。

しかし開発者向けのドキュメントなどできちんと構造化されているならばmokuji.jsのようなライブラリが使えます。mokuji.jsは目次を自動生成するライブラリです。

mokuji.jsの使い方

上半分にあるのが自動生成された目次です。

英語の場合はハッシュが英語になっています。

日本語の場合はエンコードされた文字になっています。これはWikipedia風です。

mokuji.jsを使えばドキュメントの横に目次を出したりするのが簡単になります。わざわざ目次を手で作っても文書がアップデートすると使えないものになってしまいます。あらかじめHタグできちんと定義し、mokuji.jsを使って自動生成するのがスマートです。

mokuji.jsはJavaScript製のオープンソース・ソフトウェア(MIT License)です。

hiro0218/mokuji.js: generate "table of contents".

 

MOONGIFTの関連記事

  • DevRel
  • Com2