BurgerEditorは、プラットフォーム非依存のブロックエディタです。既存のCMSに統合したり、ローカル環境で利用できます。
既存のCMSやWebアプリケーションにBurgerEditorを統合したい開発者の方は、@burger-editor/client のREADMEをご覧ください。
主な内容:
- BurgerEditorの統合方法
createBurgerEditorClientAPIの使用方法- 実装例とカスタマイズ方法
ローカルファイルシステムでBurgerEditorを使いたい方は、@burger-editor/local のREADMEをご覧ください。
主な内容:
- インストールと起動方法
- 設定ファイルのカスタマイズ
- カスタムブロックの追加方法
BurgerEditorの開発に貢献したい開発者の方は、以下の情報をご覧ください。
BurgerEditorはLernaを使用したモノレポ構成を採用しています。各パッケージは明確な責任を持ち、再利用性とプラットフォーム非依存性を重視した設計になっています。
詳細なアーキテクチャについては ARCHITECTURE.md を参照してください。
| パッケージ | バージョン | 説明 |
|---|---|---|
| @burger-editor/core |  |
エディタエンジンのコア実装 |
| @burger-editor/client |  |
SvelteベースのクライアントUI |
| @burger-editor/blocks |  |
標準ブロックとアイテムの定義 |
| @burger-editor/css |  |
ブロック用スタイルシート |
| @burger-editor/custom-element |  |
TipTap統合のWeb Components |
| @burger-editor/frozen-patty |  |
HTMLとJSONデータの相互変換ライブラリ |
| @burger-editor/legacy |  |
v3互換性サポート |
| @burger-editor/local |  |
ローカルファイルシステム向けCMS実装 |
| @burger-editor/mcp-server |  |
MCP (Model Context Protocol) サーバー実装 |
| @burger-editor/migrator |  |
バージョン間移行ツール |
| @burger-editor/utils |  |
共通ユーティリティ関数 |
# リポジトリのクローン
git clone https://github.com/d-zero-dev/BurgerEditor.git
cd BurgerEditor
# 依存関係のインストール
yarn install
# すべてのパッケージをビルド
yarn build# すべてのパッケージをビルド
yarn build
# テストの実行
yarn vitest run
# Lintの実行
yarn lint- プルリクエストを作成する前に、すべてのテストが通ることを確認してください
- コミットメッセージは Conventional Commits の形式に従ってください
- コード変更時は適切なテストを追加してください
- Cursor Rulesとプロジェクトのコーディング規約に従ってください
Dual Licensed under MIT OR Apache-2.0
This software is available under your choice of the following licenses:
-
MIT License Recommended when used as part of baserCMS or the official BurgerEditor Plugin, both developed and distributed by D-ZERO Co., Ltd.
-
Apache License 2.0 For all other use cases, including standalone, third-party, or commercial use.
Files:
LICENSE-MIT- MIT License textLICENSE-APACHE-2.0- Apache License 2.0 textNOTICE- Attribution notices (required for Apache 2.0)
For inquiries, contact: system@d-zero.co.jp