12
13

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

マークダウン形式のドキュメントサイトを超簡単に構築&公開する(Docusaurus+Github+AWS Amplify)

Last updated at Posted at 2025-02-17

はじめに

Docusaurusでドキュメントサイトを構築し、AWS Amplify Gen2で公開したのでその備忘録です。
正直なところ こんな記事を読まなくても超簡単にできちゃいます (^^;

Docusaurusって?

Meta社が開発しているオープンソースの静的サイトジェネレータです。
Reactベースのプロジェクトで、テーマも用意されている為、テーマをベースにしつつちょっとだけ手を加える、といったこともできます。

過去にこちらの記事も書いていますのでよければどうぞ。

AWS Amplifyって?

なんと表現していいいのかわかりませんが、インフラの構築からCI/CDまで全部丸っとやってくれます。

VercelやCloudflareなどとよく比較されています。

今回上で挙げたような他サービスとの比較は行わず、普段AWSを利用していることもありAmplify一択でした。
またAmplifyを触ったことが無かったので触ってみたかった、というのもあります。

それでは早速構築していきます。

手順

1. ローカルでDocusaurusを構築する

前回記事の「やってみる」章を参照してくださいm(__)m

2. Githubにプッシュする

ここも特に特別なことはありません。
今回はOrganization内のprivateなリポジトリに格納しました。

※ Organizationに対してIPアドレス制限をかけている場合、AWS Amplifyからのアクセスを受け付けるためにIPアドレスをホワイトリストに指定する必要があります、、がしかし、AWS Amplifyでは静的IPが公開されていません。
なのでIPアドレス制限を利用されている場合には注意が必要です。

3. Amplifyでデプロイする

AWSマネジメントコンソールにアクセスし、Amplifyページを開きます。
早速デプロイできそうなボタンがあるのでクリックします。
(出荷っておもろいですね)

スクリーンショット 2025-02-17 185139.png

次にGit プロバイダーをします。今回はGithubを利用します。
CodeCommitが選べるのが意外でした。CodeCatalystとの差別化ポイントは気になるところですね。

スクリーンショット 2025-02-17 185346.png

Githubを選択して次へをクリックすると、リポジトリとブランチを選択することができます。
モノレポかどうかを選択することができます。
今回このリポジトリでは1つのアプリ(ドキュメントサイト)しか管理しないので、チェックはいれませんでした。

スクリーンショット 2025-02-17 185939.png

次にビルドの設定を行います。

スクリーンショット 2025-02-17 190245.png

フロントエンドビルドコマンド

手順1でDocusaurusを構築しましたが、ビルドっぽいコマンドはどれかpackage.jsonを確認してみます。

スクリーンショット 2025-02-17 191219.png

まあbuildですよね。なのでこれはデフォルトのnpm run buildで問題ありません。

出力ディレクトリをビルド (原文ママ)

デフォルトはdistになってますが、npm run buildの結果はREADNEによると下記画像の通りbuildに出力されるので、buildと入力します。
(最初まんまと騙されました)
スクリーンショット 2025-02-17 191530.png

自分のサイトをパスワードで保護

公開はしたいものの完成するまで内容は見られたくないので、パスワードをかけます。
こいつを設定しておくと、アクセスした際にBasic認証っぽい入力欄が表示されるようになります。

スクリーンショット 2025-02-17 190909.png

ここまで出来たら次のページでこれまでの設定内容を確認し、
問題なければ「保存してデプロイ」をクリックします。
しばらく待つとURLが発行されました。

スクリーンショット-2025-02-17-192736-02-17-2025_07_29_PM.png

まだデプロイ中みたいですが・・・アクセスしてみます。
パスワード保護の設定をしていたので、ID/パスワードの入力を求められます。
入力してみると・・・

スクリーンショット 2025-02-17 192801.png

こんな感じの画面が出ました。一応領域自体は作られているような状態ですかね。
しばらく待つとデプロイ済みになったのでリロードしてみます。

スクリーンショット 2025-02-17 193248.png

無事にDocusaurusのページが表示されました。
他のページにもアクセスしてみましたが、ローカルで動かすのと遜色ないスピードでサクサクページ遷移できます。
流石静的サイト!(?)

さいごに

Amplifyがどういう仕組みで動いているのか、というところには一旦触れずに、とにかく簡単にドキュメントサイトを作って公開するという体験をしてみました。
どうなってるのかわからないまま公開できてしまう怖さはありますが、知ってしまえば怖くありません。
きちんと知って使うことでとてもスピーディな開発を実現することができそうです。

12
13
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
12
13

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?