Typemark Documentation

GitBookから移行

GitBookのスペースをGitHubに同期し、リポジトリをインポートして、GitBookのブロックをTypemarkコンポーネントに変換する1つのコミットを確認します。Markdown、画像、リダイレクトはそのまま引き継がれます。

2026年11月19日更新

GitBookはGit Syncを使って各スペースをGitHubリポジトリに書き出せます。Typemarkはそのリポジトリをインポートします。ナビゲーションにはSUMMARY.mdを読み込み、{% hint %}や{% tabs %}などのGitBookのブロックをTypemarkコンポーネントに変換します。

Mintlifyからのインポートと異なり、GitBookからのインポートではページが変更されます。GitBookのブロック構文はGitBook上でしか表示されないためです。すべての変更は1つのコミットにまとめられるので、GitHubで確認し、Gitで元に戻すこともできます。

始める前に

  • スペースでGit Syncを有効にできること。GitBookのプランのうち対象となるものでのみ利用できます。プランはGitBookで確認してください。
  • リポジトリのサイズが100 MB以下で、Gitサブモジュールを含まないこと。
  • 同期には新しい空のリポジトリを使用してください。インポートはこのリポジトリにコミットし、後からGitBookが同じファイルに書き込むことは避けたいためです。

スペースをインポートする

  1. スペースをGitHubに同期

    GitBookでスペースを開き、新しいGitHubリポジトリでGit Syncを設定します。最初の同期の方向にはGitBook → GitHubを選びます。逆方向を選ぶと、スペースが空のリポジトリで置き換えられてしまいます。

  2. Typemarkプロジェクトを作成

    New projectをクリックして名前を付け、Start fromでImport from GitHubを選びます。Create and connect GitHubをクリックし、Typemark GitHub Appにリポジトリへのアクセスを許可します。

  3. リポジトリを選択

    TypemarkにGitBook space detectedと、見つかったSUMMARY.mdが表示されます。Importをクリックして確認します。

  4. 変換コミットを確認

    Typemarkはtypemark.jsonを書き出し、すべてのページを1つのコミットで変換して、GitHubにプッシュし、サイトをビルドします。プロジェクトの概要にインポートの概要が表示されます。

  5. GitBookのGit Syncを停止

    スペースのGit Syncを切断し、GitBookがリポジトリに書き込まないようにします。

  6. 公開

    公開前チェックリストを確認し、Settings > PublishingでGo liveをクリックします。

複数のスペース、言語、バリアントがありますか? それぞれを個別のリポジトリに同期し、それぞれを別々のTypemarkプロジェクトとしてインポートしてください。言語を1つのサイトとして公開したい場合は、1つのプロジェクト内で、翻訳したページを、そのページと同じパスにある言語コード名のフォルダーに配置します。詳しくは言語を参照してください。

変換の結果

---
description: Install the SDK.
---

# Getting started

{% hint style="warning" %}
Node 18 or later is required.
{% endhint %}

{% tabs %}
{% tab title="npm" %}
```bash
npm i @acme/sdk
```
{% endtab %}
{% endtabs %}
---
title: Getting started
description: Install the SDK.
---

<Warning>
Node 18 or later is required.
</Warning>

<Tabs>
<Tab title="npm">
```bash
npm i @acme/sdk
```
</Tab>
</Tabs>

変換される内容

GitBookTypemark
SUMMARY.mdのページグループ(## Group)typemark.jsonのナビゲーションのグループ
SUMMARY.md内のネストされたページ同じグループ内で親の直後に配置されるページ。Typemarkのグループはネストしないため
.gitbook.yamlのrootスペースがリポジトリのルートにない場合のdocs_root
.gitbook.yamlのredirectsredirects
SUMMARY.mdに記載されたページ.mdxページ。記載されていないページはそのまま残り、サマリーに名前が挙げられます
folder/README.mdfolder.mdx。/folderが引き続き機能します。スペースのreadmeは最初のページとなり、/に配置されます
SUMMARY.md削除されます。ナビゲーションはtypemark.jsonに入ります
ページ最初の# Headingフロントマターのページtitle
description、hiddenのフロントマターそのまま残ります
{% hint style="info" %}<Info>
{% hint style="success" %}<Check>
{% hint style="warning" %}<Warning>
{% hint style="danger" %}<Danger>
{% hint style="tip" %}<Tip>
{% tabs %}と{% tab title="…" %}<Tabs>と<Tab title="…">
{% stepper %}と{% step %}<Steps>と<Step title="…">。タイトルはステップの見出しから取られます
コードブロックを囲む{% code title="…" %}そのタイトルが付いたコードブロック
<details>と<summary><Accordion title="…">
{% columns %}<Columns>
カードのテーブル(data-view="cards")行ごとに<Card>を持つ<CardGroup>
キャプション付きの<figure><Frame caption="…">
YouTube、Vimeo、Loom、Wistiaの動画の{% embed url="…" %}キャプション付きの<Video>
その他の{% embed url="…" %}、{% content-ref %}、{% page-ref %}、{% file %}同じアドレスへリンクするカード
{% openapi … path="…" method="…" %}<API>のエンドポイントブロック
他の.mdページへのリンクサイトルートからのTypemarkページへのリンク
.gitbook/assets/内のファイルimages/に移動し、すべてのリンクを更新します。スペースを含む名前はダッシュに置き換えられます
{% include %}の再利用コンテンツ利用している各ページにコピーされます
space.varsとpage.varsの式値に置き換えられます

引き継がれない内容

  • 組織レベルのOpenAPI仕様。 仕様ファイルをリポジトリに追加し、ナビゲーションに{ "source": "openapi.yaml" }のエントリとして記載してください。詳しくはOpenAPIを参照してください。
  • 訪問者認証、インテグレーション、サイトのカスタマイズ。 これらはリポジトリではなくGitBookの設定に保存されています。
  • {% swagger %}ブロック。 テキストのまま残り、一覧に挙げられます。代わりに仕様ファイルからエンドポイントページを生成してください。
  • Typemarkが対応していないブロック。 元の記述のまま残り、使用しているページとともにサマリーに挙げられます。

ターミナルから実行する

同期したリポジトリをご自身のコンピューターで変換するには、次のとおりです。

cd my-gitbook-repo
typemark migrate             # detects the GitBook space and converts it, then offers to create the project and push it

「yes」を2回答えると、サイトがTypemarkに移行されます。公開するまではオフラインのままです。CIやコーディングエージェントで実行する場合は、代わりにtypemark migrate --create "My Docs" --pushを使用してください。

typemark migrateは、GitHubインポートと同じ変更を書き込みます。結果をgit diffで確認できるよう、事前に作業をコミットまたはstashしてください。

コーディングエージェントと併用する

未対応のブロックやカスタムHTMLなど、残りの作業はコーディングエージェントに任せられます。

typemark migrate --from gitbook --agent claude

詳しくはコーディングエージェントと併用するを参照してください。