バージョナブルドキュメントによるドキュメント作成とバージョン管理

Posted at 2024-11-28

バージョナブルドキュメント(バージョン管理可能なドキュメント)とは、epubファイルとgitを組み合わせて使用することの総称として筆者が名付けました。
epubファイルの構成要素はHTML、CSS、JavaScriptのテキストファイルですのでgitによるバージョン管理が可能です。

epubファイルの作成、編集はSigilを想定しています。
https://sigil-ebook.com/
閲覧はCalibreを想定しています
https://calibre-ebook.com/ja

epubファイルはzip圧縮されているフォルダなので、epubファイルの.epub拡張子を.zipに変更し、各種展開アプリで展開することができます、そしてその展開されたフォルダをgitで管理します。

いままでExcel、Word、PowerPointでドキュメント作成していた人にはこれはうれしい情報でしょう。
Excel、Word、PowerPointではバージョン管理が難しいからです。
脱Excel、脱Word、脱PowerPointが実現できると思います。

筆者が作成したepubファイルの仕様書のサンプルとepubユーティリティをgithubに置いていますので確認してみてください。
このサンプルはデザイン部分をbootstrapで、ER図をmermaid.js(マーメイドjs)で作成しています。

epubの仕様書サンプル(ハンバーガー注文サイトのサンプル仕様書)
https://github.com/fieldflag/hamburger_order_site_db