開発環境ガイド

公開する

このサイトをビルドして公開する

Astroで作ったサイトを、ビルドしてレンタルサーバー(public_html)へ公開します。

このガイドのサイトは、Astro(エイストロ)という道具で作られた 静的サイト です。Markdownで書いたページを、ふつうのHTMLファイルに変換(ビルド)して公開します。ここでは、その変換と公開の手順を説明します。

全体の流れ

  1. Markdownでページを書く・直す
  2. ビルドして、公開用のファイル(dist フォルダ)を作る
  3. dist の 中身 を、サーバーの公開フォルダ(public_html など)にアップロードする

ページを追加する

手順書のページは、src/content/docs/ の下に、Markdownファイルを置いて作ります。置く場所が、上部のタブ(セクション)に対応します。

フォルダタブ
src/content/docs/start/はじめに
src/content/docs/setup/環境構築
src/content/docs/workflow/開発の流れ
src/content/docs/reference/リファレンス
src/content/posts/学習ログ

ファイルの先頭に、次のような情報を書きます。

---
title: ページのタイトル
description: ページの短い説明(省略できます)
group: 左のメニューでのグループ名
order: 1
---

ここから本文をMarkdownで書きます。
項目意味
titleページの題名。左のメニューにも表示されます
descriptionタイトルの下に表示される短い説明
group左のメニューの見出し(グループ)の名前
orderグループの中での並び順。小さいほど上に表示されます

注意書きは、> [!NOTE]、> [!TIP]、> [!IMPORTANT]、> [!WARNING]、> [!CAUTION] で始まる引用として書くと、色つきの囲みになります。

手元で確認する

プロジェクトのフォルダ(package.json があるフォルダ)で、次を実行します。初回は、先に npm install が必要です。

npm install
npm run dev

表示されたURL(http://localhost:4321/ など)をブラウザで開きます。ファイルを保存すると、画面が自動で更新されます。

検索は、npm run dev では使えません。ビルドしたあとの確認(npm run preview)で使えます。

ビルドする

公開用のファイルを作ります。

npm run build

dist フォルダに、公開用のファイルと、検索用のデータ(pagefind フォルダ)ができます。ビルドのたびに、dist の中身は作り直されます。

ビルドした結果を、公開前に確認するには、次を実行します。

npm run preview

公開する

dist フォルダの 中身すべて を、サーバーの公開フォルダにアップロードします。dist フォルダごとではなく、中身を入れてください。

public_html/
  index.html
  _astro/
  pagefind/
  docs/
  posts/
  tags/
  ...

pagefind フォルダも、必ずアップロードしてください。検索機能が使えなくなります。

ページを直したときは、もう一度ビルドして、dist の中身を上書きアップロードします。

サブフォルダに公開する場合

ドメインの直下ではなく、https://example.com/guide/ のようなサブフォルダに公開する場合は、astro.config.mjs に、次のように設定してからビルドします。

export default defineConfig({
  site: 'https://example.com',
  base: '/guide',
});

public_html/guide/ の中に、dist の中身をアップロードします。

確認する

  • npm run build が、エラーなく終わる
  • npm run preview で、すべてのページと検索を確認できた
  • dist の中身をアップロードして、公開URLで表示できた
  • 公開後に、検索(Ctrl + K)が動いた

Esc で閉じます