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

styleguide.jsはnode/JavaScript製のソフトウェア(ソースコードは公開されていますがライセンスは明記されていません)です。

Webコーディングを行う際に複数人で作業する場合はスタイルシートのクラスをどのように使うべきか記す必要があるかと思います。そんな時に使ってみたいのがstyleguide.jsです。


デモです。このHTMLファイルは自動生成されたものになります。


セクションごとの見出し付き。

styleguide.jsはルールとしてスタイルシートファイルの中にコメントでデモ用のHTMLを記述します。説明などはYAML形式で記述するようになっており、スタイルシート全体に説明を付与しておくのは分かりやすいのではないでしょうか。

実際のコードとドキュメントが分離することによる弊害はプログラマーの方であればよく知るところでしょう。そのためコードの中に○○Docと呼ばれる形で記述するスタイルが多いです。スタイルシートでも同様の作業はできるはずです。

最初は整合性のとれているスタイルシートも更新が重なると次第につきはぎだらけになって設定がどこで使われているか把握しきれなくなっていきます。その結果、修正は行わず常に追加するといった形になるのはよくあることです。そうならないためにも体系化されたドキュメントは用意すべきでしょう。

EightMedia/styleguide.js

 

MOONGIFTの関連記事

コメント

  • DevRel
  • Com2