Skip to content

v0.1.0 — MVP

Choose a tag to compare

@kpab kpab released this 26 Apr 04:43
· 29 commits to main since this release

🎉 shotflow の最初のリリース。

スクリーンショット + YAML を入力に、ブラウザで動作する 単一 HTML の画面遷移図 を生成する CLI ツール。業務システムのドキュメント整備、レガシー画面の説明資料、スクショベースの仕様書を主用途として設計。

Highlights

  • 📦 単一 HTML 出力 — 画像を base64 で埋め込み、配布や共有が簡単
  • 🗺️ dagre による自動レイアウト — グループ間の配置だけ宣言、内部は自動
  • 🖼️ 2 段階画像埋め込み — サムネ (600px) + 原寸 (2000px) を WebP で同梱
  • 🔍 パン/ズーム + lightbox — svg-pan-zoom で俯瞰、クリックで原寸拡大
  • 📝 YAML スキーマ — groups / screens / transitions / layout / image
  • 🎯 矢印タイプ — default (実線) / modal (短破線 + 半透明)
  • 🖥️ CLI: shotflow build <config> -o <output> + --thumbnail-width, --original-width, --quality, --format, --no-original
  • 📚 プログラマティック API — build, parseConfig, render, buildFromObject を export

Status

パブリック API は v1.0 まで experimental です。マイナーリリースで破壊的変更が入ることがあります。

詳細は CHANGELOG.md を参照。