Docusaurus はドキュメントを build/ 内の静的サイトにビルドします。各ドキュメントとブログ記事が HTML になり、検索とナビゲーションはブラウザで動作します。Lobsite はそのフォルダをホストします。npm run build を実行してから npx lobsite を実行すると、HTTPS 対応の *.lobsite.app アドレスでドキュメントが公開されます。デプロイごとに専用の URL も付くので、公開前にドキュメントの変更をレビューするのに便利です。
仕組み
npm run buildでドキュメントをビルドします。Docusaurus はbuild/にサイトを書き出し、デフォルトではリンク切れがあるとビルドが失敗します。- プロジェクトで
npx lobsiteを実行します。デプロイされるのはbuild/で、static/ではありません。最初のデプロイにアカウントは不要で、6 時間有効です。 - 取得リンクから無料アカウントにサイトを残します。その後は
npm run build && npx lobsiteで同じアドレスが更新されます。
url、baseUrl、末尾のスラッシュ
// docusaurus.config.js
export default {
url: "https://my-docs.lobsite.app",
baseUrl: "/",
};
urlはサイトのアドレスです。Docusaurus は正規リンクとサイトマップに使用します。baseUrlは Lobsite では/です。GitHub Pages のプロジェクトサイトでは/repo-name/を使いますが、そのままにするとすべてのアセットリンクが壊れます。trailingSlashは省略できます。docs/intro/index.htmlとしてビルドされたドキュメントは/docs/intro/で開き、/docs/introはそこにリダイレクトされます。
ドキュメントの変更をレビューする
ドキュメントは多くの人が書き、他の人がレビューすることがよくあります。lobsite deploy --preview は、公開中のドキュメントに影響を与えず専用の URL でビルドを公開するため、レビュアーは実際の表示で変更を確認できます。lobsite promote で本番に公開し、lobsite rollback で 1 ステップで前のバージョンに戻せます。ページを移動する場合は、検索結果や他サイトからのリンクが機能し続けるよう、古いパスのリダイレクトを lobsite.toml に追加してください。リダイレクトジェネレーターでルールを作成できます。AI コーディングエージェントは、質問で止まることのない npx -y lobsite --yes で同じデプロイを実行できます。
公開前にプレビューできます。リダイレクトも含めてワンクリックでロールバックできます。
ファイルはハッシュで保存されます。変更のないサイトを再デプロイしてもアップロードは 0 バイトです。
すべてのサイトに、最初のデプロイから HTTPS 対応の *.lobsite.app アドレスが付きます。
リダイレクト、ヘッダー、フォームは lobsite.toml に記述し、デプロイごとに一緒に反映されます。
エージェント実行時は確認を求めず、URL と取得リンクを含む Tell the user: 行を出力します。
すべての制限は公開されており、すべてのエラーが次にすべきことを教えてくれます。
Docusaurus ホストの比較
| Lobsite | GitHub Pages | Netlify | Vercel | |
|---|---|---|---|---|
| ドキュメントのビルド | いいえ: build/ をデプロイ |
GitHub Actions、または docusaurus deploy |
はい | はい |
| デプロイごとのプレビュー URL | はい | いいえ | はい | はい |
| 1 ステップのロールバック | はい | コミットを元に戻す | はい | はい |
| 最初のデプロイ前のアカウント | 不要: 6 時間公開、その後無料で残せる | 必要（リポジトリも） | 必要 | 必要 |
| カスタムドメイン | はい、無料 | はい、無料 | はい | はい |
GitHub Pages はコードと一緒に管理するオープンソースのドキュメントに適しています。Lobsite は、ローカルや CI でビルドし、ホスティングのための Git ワークフローなしでプレビュー、昇格、ロールバックしたいドキュメントに向いています。
よくある質問
Lobsite で Docusaurus はどの baseUrl を使うべきですか？
/ です。サイトはアドレスの最上位から配信されます。/repo-name/ が必要なのは GitHub Pages のプロジェクトサイトのみです。
Docusaurus の検索は静的ホストで動作しますか？
はい。Algolia DocSearch は訪問者のブラウザで動作し、ローカル検索プラグインはインデックスを build/ にビルドします。どちらもサーバーは不要です。
バージョン管理された Docusaurus ドキュメントをホストできますか？
はい。各バージョンは専用のページとして build/ にビルドされ、すべて一緒にデプロイされます。前回のデプロイから変更されたファイルのみがアップロードされます。
Docusaurus サイトはどのくらいの大きさまで可能ですか？
無料プランでは 1 回のデプロイあたり 100 ファイル、50 MB までで、多くのドキュメントサイトに十分です。多数のバージョンや画像を含む大きなドキュメントには、近日提供予定の有料プランが必要です。すべての制限は制限の表にあります。