Skip to content

make packageでQuartoビルド可能な配布パッケージを生成 #3

@dobachi

Description

@dobachi

概要

make packageコマンドで、受け取った人がすぐにQuartoでビルドできる完全な配布パッケージを生成できるようにする。現在のpackageは成果物中心だが、Quartoプロジェクトとして完結した形で配布できるようにする。

現状の問題

現在のmake package(Makefile:112-197)は:

  • 成果物(HTML/PDF)とソースファイル(.qmd)を個別にコピー
  • Quarto設定ファイル(_quarto.yml)が含まれていない
  • スタイルファイルやテンプレートが含まれていない
  • 受け取った人が単独でビルドできない

要件

含めるべきファイル(Quartoビルドに必要)

  • _quarto.yml:Quarto設定ファイル
  • templates/:テンプレートファイル
    • templates/report_template.qmd
    • templates/styles/(CSS、SCSSなど)
  • sources/references/:参考文献(.bib)
  • sources/diagrams/:図表ソース
  • reports/またはexamples/:報告書ソース(.qmd)
  • scripts/build-quarto.sh:ビルドスクリプト(オプション)
  • scripts/setup-quarto.sh:セットアップスクリプト(オプション)
  • Makefile:ビルドコマンド(オプション)

除外すべきファイル(AI指示書関連)

  • instructions/:AI指示書システム全体
  • CLAUDE*.mdCURSOR*.md:AI用設定ファイル
  • .github/:GitHub Actions設定(オプション:配布先でCI/CDが不要なら除外)
  • scripts/checkpoint.shなど:AI指示書関連スクリプト

パッケージ構造(案)

research-report-YYYYMMDD.zip
├── README.md           # ビルド方法を記載
├── _quarto.yml         # Quarto設定
├── Makefile            # ビルドコマンド(オプション)
├── templates/          # テンプレート
│   ├── report_template.qmd
│   └── styles/
│       ├── custom.scss
│       └── report-style.css
├── sources/
│   ├── references/     # 参考文献
│   │   └── bibliography.bib
│   └── diagrams/       # 図表
├── reports/            # 報告書ソース
│   └── *.qmd
└── scripts/            # ビルドスクリプト(オプション)
    ├── build-quarto.sh
    └── setup-quarto.sh

READMEの内容

配布パッケージのREADMEには以下を記載:

  1. 必要な環境(Quarto、XeLaTeX、フォント)
  2. セットアップ手順
  3. ビルド方法(quarto renderまたはmake report
  4. カスタマイズ方法

実装方針

1. 新しいMakefileターゲット追加

make package-quartoまたはmake packageを改修して:

  • Quartoプロジェクトとして完結したファイル一式をコピー
  • AI指示書関連を明示的に除外
  • 配布先でquarto renderが実行できることを確認

2. README生成の改善

現在のREADME生成(Makefile:152-187)を改善:

  • Quartoのインストール手順を詳細に記載
  • 日本語PDF生成のための環境構築手順
  • ビルドコマンド例(quarto rendermake

3. テスト

  • 生成したパッケージを展開
  • 独立した環境でquarto renderが成功することを確認
  • CI/CDでパッケージ生成をテスト(オプション)

期待される成果

  • 受け取った人がquarto renderですぐにビルドできる
  • Quartoプロジェクトとして完全に動作する
  • AI指示書システムに依存しない独立したパッケージ
  • 他のプロジェクトへの移植が容易

参考

  • Makefile:112-197(現在のpackageターゲット)
  • _quarto.yml(Quarto設定)
  • templates/(テンプレートディレクトリ)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions