cloudcannon-bookshop

CloudCannon Bookshop

Bookshop は CloudCannon の以前のコンポーネントシステムです。コンポーネントライブラリ、エディターの構造を生成するビルドステップ、Visual Editor でコンポーネントを再レンダリングするライブ編集エンジンで構成されています。編集可能な領域がこれに代わります。このスキルでは、Bookshop サイトの確認、稼働状態の維持、Bookshop からの移行について説明します。

使用する場合

• § Bookshop の検出に該当するシグナルがサイトにある場合
• Bookshop サイトでコンポーネントを追加または変更する場合
• Bookshop サイトを編集可能な領域に移行する場合
• Bookshop のライブ編集、構造、またはビルドに問題がある場合

使用しない場合

• サイトに Bookshop のシグナルがない場合 — cloudcannon-visual-editingを使用してください。Bookshop を使用していないサイトに Bookshop を追加してはいけません。新しいコンポーネント編集には常に編集可能な領域を使用します。
• Bookshop がなくなり、領域だけが残っている場合 — トラブルシューティングも含め、cloudcannon-visual-editingを使用してください。
• コンポーネントに関係しない設定の場合 — cloudcannon-configurationを使用してください。

Bookshop の検出

いずれかのシグナルがあれば、そのサイトは Bookshop を使用しています。

シグナル	場所
bookshop/bookshop.config.{js,cjs}	src/（Astro）または component-library/（Hugo、Eleventy、Jekyll、Next.js）
各コンポーネントの隣にある *.bookshop.{yml,yaml,toml,json,js,cjs}	component-library/components/ または src/components/
@bookshop/* パッケージ	package.json の dependencies または devDependencies
npx @bookshop/generate	.cloudcannon/postbuild
_bookshop_name キー	フロントマター。通常は content_blocks の下にあり、コンポーネントコードにある場合もあります
SSG の Bookshop プラグイン、モジュール、またはインテグレーションと、そのテンプレート呼び出し	サイト設定とレイアウト — SSG の bookshop.md を参照してください

SSG のサポート

編集可能な領域で SSG のコンポーネントを再レンダリングできる場合に移行します。それ以外の場合、サイトは Bookshop を使い続けます。

SSG	Bookshop エンジン	パス	ドキュメント
Astro	@bookshop/astro-engine	移行 — migrating-to-editable-regions.md	astro/overview.md
Hugo	@bookshop/hugo-engine	移行 — migrating-to-editable-regions.md	hugo/overview.md
Eleventy	@bookshop/eleventy-engine	移行 — migrating-to-editable-regions.md	eleventy/overview.md
Next.js	なし — @bookshop/generate は構造のみを書き込みます	移行 — migrating-to-editable-regions.md	nextjs/overview.md
Jekyll	@bookshop/jekyll-engine	Bookshop を使い続ける — maintaining.md。編集可能な領域はまだ Jekyll コンポーネントをサポートしていません	—

保守するか、移行するか？

ユーザーの希望…	対応すること
コンポーネントの追加または変更のみ	maintaining.md — 求められていない移行は始めないでください
Bookshop を離れ、「移行」と記載された SSG を使う	migrating-to-editable-regions.md
Bookshop を離れ、「継続」と記載された SSG を使う	まだ不可能であることを説明し、maintaining.md を案内します
サイトを CloudCannon に移行した（migrate-to-cloudcannon）	その移行の各フェーズ内で移行します — 移行ファイルに手順が記載されています
不明	尋ねてください。移行ではすべてのコンポーネントとページレイアウトを書き換えます

目次

ファイル	内容
SKILL.md (このファイル)	検出、SSG のサポート、振り分け
bookshop.md	Bookshop の仕組み — ライブラリの構成、*.bookshop.yml、@bookshop/generate、ライブ編集、バインディング
maintaining.md	Bookshop を使い続けるサイトの変更方法
migrating-to-editable-regions.md	手順の順序、*.bookshop.yml の構造、_bookshop_name の名前変更、Bookshop の削除
troubleshooting.md	症状 → 原因 → 修正。Bookshop サイトと移行途中のサイトを対象とします

SSG 固有のドキュメント：

SSG の overview.md から読み始めてください。各 SSG のファイルを読む順序が記載されています。

SSG	ドキュメント	目的
Astro	astro/overview.md	Astro の場合はここから始めてください
Hugo	hugo/overview.md	Hugo の場合はここから始めてください
Eleventy	eleventy/overview.md	Eleventy の場合はここから始めてください
Next.js	nextjs/overview.md	Next.js の場合はここから始めてください

その他のスキル：

スキル	読むタイミング
cloudcannon-visual-editing	移行中 — リージョン、調査、完了チェックリストについて
cloudcannon-configuration	生成された構造を置き換える _structures の作成と検証について
cloudcannon-dev-server	ローカルエディターで移行後のサイトをユーザーに試してもらう場合

よくある誤り

言い訳	実際のところ
「Bookshop のサイトだから移行しよう」	ユーザーが依頼し、かつ SSG が「移行」と示されている場合に限ります。Bookshop サイトでのコンポーネント変更は Bookshop の変更です。
「この新しいコンポーネントは editable-regions にできる」	Bookshop を使い続けるサイトでは、新しいコンポーネントは Bookshop コンポーネントです — maintaining.md § Adding a component。