watilde / aigis

Ronde

Components Styleguide generator.

コンポーネントのスタイルガイドを目指す。イメージはnode版hologram

way

• CSSファイルのコメントにスタイルガイド用の記述を行う
  • Markdownで記述
  • 設定はCSON

done

• 済:テンプレートをわける
  • header
  • footer
  • main
  • sidemenu
• 済:タグ機能
  • tagsかな
• 出力
  • 済:カテゴリごと
  • コメント単位？
• ボツ:KSS構文
• 済:Scss対応
• 済:Stylus対応
• 済:codeblockのhighlight
  • scss, sass
  • stylus
  • less
• 済:どのcssファイルから出力されたかモジュール単位の出力に刻印を入れる
  • relativeで
• 済:ユーザーが拡張できるように
  • configにotherがあったらそれをテンプレートに渡してあげる?
  • configそのまま渡せばいいかも
• 済:設定をYAMLとJSONで書けるように
• 済:設定からハイライトのファイル指定できる
• 済:同じtagまとめたページ
• 済:時間のフォーマットを指定できるように
• 済:moduleのnameからページ内容のモジュール一覧（#リンクでとべる）
  • テンプレートにモジュールの名前とリンクを渡す
• 済:モジュールの名前にホバーしたらアンカーを表示させる
• 済:highlightの背景を設定する

ToDo

• デバッグロッグを出す

• headermenuいる？

• Handlebarsのテンプレートをキャッシュする

• カテゴリの説明文を追加したい？

• カテゴリなしのコメントをuncategolized的なやつにまとめる

• モジュールの書き出し順を制御する何か

• tagの並びをソートする（表示順を一律に）

• indexページを作る

  • sidemenuに渡してるのと同じの渡せばよさそう

• mdから普通のドキュメント作れるようにする？

  • カテゴリーとかタグとか関係なくルールを乘せる的な用途

• プロジェクト名を表示する

• 設定ファイルの指定を外部からできるように

• 設定ファイルなくてもオプションでオプション指定できるように

• 付与するidにプリフィックスをつける

  • KSSっぽいの

• 名前変える？

考え中

• CSSのコメントに書くとシンタックスハイライト効かない問題

  • markdownで適当に書くくらいで十分なときもある

• HTMLを外部テンプレート（html）で書けるようにする

  • 1モジュール1ファイルだけだとファイル増えまくる問題
  • HTMLにid属性指定してhtml: "./hoge.html#moduleName"みたいなことするとか

• Sass対応

  • @importしてるファイル名を書き出す
    • ジェネレートの対象がモジュール単位のファイル前提になっちゃう
    • そもそもいらない？
  • @extend
    • めんどくさそう

• Markdownrendererのカスタマイズ機能重要

• 最初からモジュールとコード表示しておく意味ある？

  • モジュールの見た目だけ確認
  • JavaScriptで制御する
    • 一気に開くとか

• sassdoc対応