同期
Typemark と GitHub の間で変更がどう伝わるか、編集が衝突したときの動作、同期される内容について説明します。
2026年11月19日更新
プロジェクトを GitHub に接続すると、変更は双方向に流れます。Typemark で保存すると、そのコミットが GitHub に反映されます。GitHub にプッシュすると、サイトが再ビルドされます。
同期の仕組み
エディターでページを保存すると:
- Typemark は、あなたを作成者として変更をコミットします。
- Typemark は、そのコミットをデプロイブランチ、またはエディターで作業中のエディターのブランチに GitHub へプッシュします。GitHub 上に Typemark がまだ持っていないコミットがある場合、Typemark はそれを取り込んでから再度プッシュします。
- 自動デプロイモードでは、ページはコンパイルが終わり次第公開されます。GitHub を経由する往復を待つことはありません。
Typemark で行った画像のアップロードや設定の変更も、同様にコミットされ、GitHub にプッシュされます。
デプロイブランチ
ライブサイトが再ビルドされるのは、デプロイブランチへのプッシュだけです。他のブランチへのプッシュはライブサイトに影響しないため、機能ブランチで下書きを作成し、準備ができたらマージできます。Pro および Enterprise プランでは、次の 2 種類のブランチがそれぞれ独自のサイトを持ちます。
- デプロイブランチへのプルリクエストにはプレビューが作成され、そのブランチへのプッシュのたびに再ビルドされます。
- エディターで作成したブランチは、同じ名前で GitHub にプッシュされます。GitHub 上でそのブランチにプッシュされたコミットは、次回プレビューがビルドされるときに取り込まれます。
オーナーがデプロイブランチを変更すると、同期も新しいブランチに追従します。詳しくはブランチを参照してください。
編集が衝突したとき
Typemark は、保存のたびに、開いたページのバージョンと照合します。その間にページが変更されていた場合(GitHub へのプッシュや、チームメンバーによる保存によるもの)、保存は停止され、Page was modified と表示されます:
- Reload page を選択すると、最新バージョンが読み込まれます。未保存の変更は失われるため、残したい内容は先にコピーしてください。
- Keep editing を選択するとダイアログが閉じ、変更はエディターに残ります。
自動マージは行われません。
Typemark が GitHub の変更を取り込めない場合(例: マージの競合)、デプロイは失敗し、ライブサイトには前回のビルドが引き続き表示されます。エラーはプロジェクトの概要ページに表示されます。
手動デプロイと GitHub
手動デプロイでは、Typemark のエディターで保存された編集は保留されます。GitHub へのプッシュでは、サイトが再ビルドされ、変更されたページがすぐに公開されます。
同期される内容
| コンテンツ | GitHub と同期 |
|---|---|
ページ(.mdx と .md) | はい |
typemark.json | はい |
| リポジトリ内の画像やその他のファイル | はい |
| コミット履歴 | はい |
| サイトのステータス、デプロイモード、カスタムドメイン | いいえ。これらは Typemark のプロジェクト設定です |
| チームメンバーとロール | いいえ |
Typemark が使用しないファイル
リポジトリには、ドキュメント以外のものも含まれることがあります。たとえば、docs フォルダの隣にあるアプリケーションコード、README、ライセンス、CI ワークフローなどです。Typemark が使用するのは、ドキュメントサイトに必要なファイルだけです。
- リポジトリのルートにある
typemark.json - ページ:
.mdxと.md - OpenAPI 仕様などの
.json、.yaml、.ymlファイル - 画像、動画、音声、フォント、PDF:
.png、.jpg、.jpeg、.gif、.webp、.avif、.svg、.ico、.bmp、.mp4、.webm、.mp3、.wav、.woff、.woff2、.ttf、.otf、.pdf(大文字・小文字は問いません)
docs_root を指定している場合、対象になるのはそのフォルダ内のファイルのみです。加えて、エディターからのアップロード先であるルートの images フォルダと、ロゴや OpenAPI 仕様など typemark.json が参照するファイルも対象になります。.github のように名前がドットで始まるフォルダ内のファイルや、.gitignore のようなファイルは、一切使用されません。
それ以外のファイルはすべて Typemark が無視します。無視されたファイルはリポジトリとその履歴に残り、Typemark での保存によって変更や削除されることはありませんが、サイトの一部にはなりません。プロジェクトの概要ページに表示される各公開の結果には、無視されたファイルの一覧が含まれます。サイトをインポートした際のインポートサマリーにも同じ一覧が表示されます。これは警告であり、エラーではありません。サイトは引き続きビルドされます。