クイックスタート

新しいブックを初期化

最も簡単な方法:

guidebook init my-book

以下が作成されます:

my-book/
├── book.json       # 設定
├── README.md       # イントロダクション(index.html になる)
└── SUMMARY.md      # 目次

SUMMARY.md を編集してチャプターを追加し、執筆を開始します。

手動セットアップ

手動でフォルダを作成する場合:

my-book/
├── README.md       # イントロダクション(index.html になる)
├── SUMMARY.md      # 目次
└── chapter1.md     # コンテンツ

README.md

# 私のブック

ようこそ!

SUMMARY.md

# 目次

* [はじめに](README.md)
* [第1章](chapter1.md)

chapter1.md

# 第1章

これは最初の章です。

プレビュー

cd my-book
guidebook serve

ブラウザで http://localhost:4000 を開きます。

ファイルの変更を監視し、自動的にリロードします。

本番用ビルド

guidebook build -o _book

_book フォルダに静的 HTML ファイルが生成されます。

デプロイ

_book フォルダを任意の静的ホスティングにアップロード:

  • GitHub Pages
  • Netlify
  • Vercel
  • Cloudflare Pages
  • 任意の Web サーバー