Typemark Documentation

GitHubへの接続

プロジェクトをGitHubリポジトリにリンクすると、Typemarkで編集したり、ご自身のエディタからプッシュしたりできます。

2026年11月19日更新

すべてのプロジェクトは、TypemarkがホストするGitリポジトリから始まります。GitHubに接続すると、ドキュメントはご自身のリポジトリに保存されます。Typemarkで編集するか、エディタからプッシュすると、どちらもサイトに反映されます。どのプランでも接続でき、設定はプロジェクトのオーナーが行います。

リポジトリを接続する

  1. GitHub Appをインストールする

    プロジェクトで Settings > GitHub に進み、Connect to GitHub をクリックします。GitHubから、Typemarkアプリをインストールする場所と、アプリがアクセスできるリポジトリの指定を求められます。

    別のプロジェクトで既にGitHubアカウントまたは組織を接続している場合は、Settings > GitHub に一覧が表示されます。それをクリックすると、そのリポジトリに直接移動します。

  2. リポジトリを選ぶ

    Typemarkに戻り、一覧からリポジトリを選びます。一覧にない場合は、Give Typemark access to it on GitHub をクリックし、アカウントの横にある Configure をクリックして、リポジトリを追加して保存します。GitHubから一覧に戻ります。新規で始める場合は、先にGitHubで空のリポジトリを作成してから選んでください。

  3. ブランチを選ぶ

    Branch から別のブランチを選ばない限り、サイトはリポジトリのデフォルトブランチから公開されます。ブランチが多いリポジトリでは、入力して検索できます。空のリポジトリにはまだブランチがないため、Typemarkはデフォルトブランチを使用します。詳しくは ブランチ を参照してください。

  4. コンテンツの扱いを選ぶ

    Typemarkがリポジトリを確認し、実行すべき内容を提案します。次のセクションを参照してください。

  5. 接続する

    Connect をクリックして確認します。Typemarkがリポジトリを同期し、サイトを再ビルドします。

プロジェクトを新規作成するときに Import from GitHub を選ぶと、GitHubから始めることもできます。その場合、Typemarkが直接GitHub Appのインストール画面に移動します。

コンテンツがどうなるか

Typemarkは、現在のドキュメントをリポジトリのデフォルトブランチにプッシュします。

Typemarkは、選んだブランチ上の既存のTypemarkプロジェクトを認識し、それを取り込みます。ブランチの内容が、Typemark上の現在のドキュメントを置き換えます。

リポジトリに docs.json または mint.json がある場合は、Import from GitHub を選択します。Typemarkは設定を typemark.json に変換し、既存のページを公開します。詳しくは ドキュメントの移行 を参照してください。

どちらかを選択します:

  • Push docs to GitHub: Typemarkのコンテンツが、選んだブランチ上のファイルを置き換えます。
  • Pull from GitHub: ブランチの内容が、Typemark上のドキュメントを置き換えます。ビルドするには、ルートに typemark.json が必要です。

要件

  • プロジェクトごとに1つのリポジトリです。別のプロジェクトに既に接続されているリポジトリは、再度接続できません。
  • リポジトリは100 MB以下である必要があります。
  • Gitサブモジュールはサポートされていません。
  • Typemarkはドキュメントサイトに必要なファイルのみを使用するため、ドキュメントをコードと同じリポジトリに置けます。詳しくは Typemarkが使用しないファイル を参照してください。

接続後

  • Typemarkエディタでの保存は、あなたを作成者としてコミットされ、GitHubにプッシュされます。
  • デプロイブランチへのプッシュは、サイトを再ビルドします。詳しくは 同期 を参照してください。
  • ProおよびEnterpriseプランでは、デプロイブランチへのプルリクエストにプレビューが作成されます。
  • サイトは、選んだブランチから公開されます。オーナーは後から Settings > GitHub で変更できます。詳しくは ブランチ を参照してください。
  • Settings > GitHub には、接続されたリポジトリと、公開元のブランチが表示されます。

接続の解除

Settings > GitHub で Disconnect をクリックし、確認します。

  • プロジェクトは、Typemarkがホストするリポジトリに戻ります。内容は最後の同期時点のものです。
  • GitHubのリポジトリは変更も削除もされません。
  • 双方向の同期は停止します。
  • 後で、同じリポジトリまたは別のリポジトリに再接続できます。