HonKit からの移行

guidebook は HonKit のドロップイン置き換えとして設計されています。

クイック移行

  1. guidebook をインストール：

    curl -fsSL https://raw.githubusercontent.com/guide-inc-org/guidebook/main/install.sh | sh

  2. コマンドを置き換え：

    # 以前（HonKit）
npx honkit build
npx honkit serve

# 以後（guidebook）
guidebook build
guidebook serve

これだけです！設定の変更は不要です。

互換性

サポート対象

  • book.json 設定
  • SUMMARY.md フォーマット
  • LANGS.md 多言語対応
  • Markdown レンダリング
  • カスタムスタイル
  • ほとんどのプラグイン（collapsible-chapters、back-to-top-button）

未サポート

  • PDF/EPUB エクスポート（Web のみ）
  • JavaScript プラグイン（guidebook は組み込み Rust 実装を使用）
  • GitBook レガシーフォーマット

移行のメリット

機能HonKitguidebook
インストールNode.js + npm単一バイナリ
ビルド速度秒単位ミリ秒単位
依存関係多数なし
自己更新手動guidebook update

CI/CD の移行

以前（HonKit）

- uses: actions/setup-node@v4
- run: npm install -g honkit
- run: honkit build

以後（guidebook）

- run: |
    curl -sL https://github.com/guide-inc-org/guidebook/releases/latest/download/guidebook-linux-x86_64.tar.gz | tar xz
    ./guidebook build