website metalsmith

ファーストウェブサイト

警告：
このリポジトリは、2023年6月までのFastify Webサイトの以前の本拠地でした。
新しい家は現在、 fastify/website-next

このプロジェクトは、Webサイトのファースト化のためにWebサイトを構築し、オンラインで公開するために使用されます。

要件

• ノード12+
• npm installで依存関係をインストールします

建てる

Webサイトのビルドをトリガーするには、実行する必要があります。

npm run build

これにより、ビルド（静的Webサイト）の作成に必要なすべての手順が実行されます。

開発している場合は、実行できます。

npm start

これにより、ビルドがトリガーされ、Webサイトで実行されている変更を視覚化できるライブサーバーも起動します。

（Webサイトのコンテンツを構成する資産を変更するたびにnpm run build:websiteを起動する必要があることに注意してください。

ステップを構築します

ビルドプロセスの仕組みについて詳しく知りたい場合は、実行中に実行される主な手順を次に示します。

1. クリーンアップ：以前のビルドから作成した可能性のある一時的なリソースを削除する
2. TEMPフォルダの作成：ビルドプロセスに必要なフォルダを作成する
3. リリースの取得：GitHub APIを使用して、ドキュメントページを動的に再生できるように、Fustifyの最新リリースをダウンロードします。
4. プロセスリリース：リリースのプロセス元のFastifyリリースから派生するすべての必要な動的ファイルを作成します（主にドキュメントページを生成および処理するために使用されます）
5. Webサイトの生成：Metalsmithを使用して、Webサイトの静的バージョンをコンパイルします。

パッケージスクリプトをチェックアウトして、上記の手順のいずれかについてコードを確認する場合に備えて、これらのアクションをトリガーするファイルを理解します。

githubページとして公開

Webサイトは、GitHubページ（Branch gh-pages ）を使用してCIを自動的にサークルCIを公開します。

マスターに変更が行われるたびに、ビルドが正常に作成された場合、GitHubページで自動的に公開されます。

これが機能するためには、必要なすべての環境変数を提供するために、Circle CIを正しく構成する必要があります。

• DOMAIN ：githubページで使用されるカスタムドメイン（ www.fastify.io ）
• GH_EMAIL ：sircleciでgh-pagesブランチにプッシュすることを許可されたGithubユーザーの電子メール
• GH_NAME ：circleciで承認されたgithubユーザーのユーザー名はgh-pagesブランチにプッシュするように
• GH_TOKEN ：（オプション） GH_NAMEで指定されたユーザー用のGitHub Personal Accessトークン。これが存在する場合、GitHubへのAPI呼び出しは認証されます。
• CLOUDFLARE_EMAIL ：CloudFlareアカウントのメール
• CLOUDFLARE_AUTH_KEY ：cloudflare apisでAPI呼び出しを実行する認可キー
• CLOUDFLARE_ZONE ：現在のドメインに関連付けられているcloudflareゾーンのID

貢献

誰もがこのプロジェクトに貢献することを大歓迎します。バグを送信したり、問題を開いたり、プルリクエストを送信したりすることで改善を提案するだけで貢献できます。

ライセンス

MITライセンスに基づいてライセンスされています。 ©OpenJS FoundationおよびFastifyチーム。