zk33 / wig

DRY-concept static site/document generator

wig.js

DRY-concept static site/document generator

Documentation

• https://zk33.github.io/wig/

License

ISC

wig's Issues

ディレクトリ内に同じ名前のディレクトリとファイルを作れるように

• sample.html
• /sample/

が同じディレクトリに同居できない

_contents:{
  "sample":{ name:"sample"},
  "sample":{ _contents:{}}
}

"index.html":{"_ext":""} っていうのできるようにしたらいいのかもしれない

負荷軽減

• テンプレートのキャッシュを保持するようにしてテンプレートとdataの両方が更新されている場合に限りページがrender/保存されるようにする
• 可能な限り更新されてるデータのみ読み込まれるようにする
• データの読み込み処理をもうちょっとシンプルにできないか検討する

スプレッドシート対応する

Excelとcsv/tsvに対応する

【例】dataディレクトリにdata.xslxが置いてあったら

{{data.シート名.行ID.列ID}}でセル
{{data.シート名._rows}}で全部の行
{{data.シート名._cols}}で全部の列

にアクセスできる、的な感じ

出力時のエンコーディング指定できるようにする

shift-jisに書き出ししたい案件発生につき

カスタムタグの追加できるようにする

https://mozilla.github.io/nunjucks/api.html#custom-tags

全体のページ一覧を生成する

published
updated
のパラメータを用意して、それを元にソートもしておく？

rootにいるときの_rel_rootの値は「.」にする

{{_rel_root}}/xxxx/としているときにrootディレクトリ直下のファイルで_rel_rootがカラになるので絶対パスになって問題が起こるため。

{{_rel_root}}xxxxみたいにスラッシュつけないのを強制する方向もあるけどテンプレート綺麗じゃないのでナシで。

初期化/コマンドオプションでテンプレートに渡すグローバル変数をセットできるようにする

開発時のみ出力する、とかできるようにするため

Markdown対応

• dataに.mdのファイルがあったらパースしてHTMLとして読み込む
• textとして読み込んだものをMarkdownとして出力するswig filterを書く
  • …のは専用のswigフィルタの便利パッケージを別に作るほうがいいかも

markdownのシンタックスハイライトとgfm対応化

markedのオプション指定を変える＋highlight.jsでシンタックスハイライト

テンプレートディレクトリを複数指定できるようにする

配列の最初に指定したディレクトリが優先される

data処理のプラグイン対応化

dataファイルの拡張子（もしくは正規表現ベースのルール？）でファイル内容の処理を変えられるようにする。内部の構造もそういう作りに変える

READMEにコマンドラインじゃないほうの使い方も書いとく

普通にrequire('wig')で使う場合の件書いてなかった

差分レンダリング出来る仕組みを作る

dataが更新されている→そのdataが関連するページのみ更新する

templateが更新されている→そのテンプレートが関係するページのみ更新（includeとか考えると多分難しいので無理っぽいが検討してみる）

Documentation

• wigで生成してサンプルを兼ねる
• docsフォルダに入れて公開できるようにする
• あわせてREADMEを更新する

nunjucksのrendererを作る

• 速度的にどうか
• API的にどうか
• テンプレートの互換性的にどうか

初回のビルドの場合にファイル内容を元に上書きするかどうか判定する仕組みを追加する

現状、初回は全てのファイルがビルドされるため、ファイルの更新日時が変わってしまう。
キャッシュのない初回ビルドの場合はファイルの中身を読んで更新する仕組みを追加する

data上でテンプレート強制指定できるようにする

data上の指定によって強制的に特定のテンプレートを割り当てられるようにする。
「_template」で指定。パスはテンプレートディレクトリをrootとする絶対パス

ディレクトリごとに内包するページの一覧を生成する

_contents内のフォルダに対する変数指定が正しく反映されてない

yaml対応

markdownでyamlの仕組み入れるのでついでにyamlも対応してしまってよさそう

カスタムフィルタの追加できるようにする

https://mozilla.github.io/nunjucks/api.html#custom-filters