website metalsmith

快速燃料

警告：
該存儲庫是Fastify網站的前任，直到2023年6月。
新家現在是fastify/website-next

該項目用於構建用於快速網絡框架的網站並在線發布。

要求

• 節點12+
• 使用npm install安裝依賴項

建造

為了觸發網站的構建，您只需要運行：

npm run build

這將執行創建構建所需的所有步驟（靜態網站）。

如果您正在開發，則可以運行：

npm start

這將觸發構建，並啟動一台Live服務器，使您可以可視化網站上執行的更改。

（請注意，每當您更改構成網站內容的資產時，您將需要啟動npm run build:website以觸發重建）

建立步驟

如果您有興趣了解構建過程的工作原理，這是執行過程中執行的主要步驟：

1. 清理：刪除可能從以前的構建中創建的臨時資源
2. 臨時文件夾創建：為構建過程創建所需的文件夾
3. 獲取版本：使用GitHub API下載Fastify的最新版本，以便可以動態地重新生成文檔頁面。
4. 流程發布：處理釋放的過程創建從原始快速版本派生的所有必要的動態文件（主要用於生成和處理文檔頁面）
5. 網站生成：使用金屬史密斯來編譯網站的靜態版本。

查看包腳本以了解哪些文件觸發這些操作，以防您要查看上述任何步驟的代碼。

出版作為github頁面

該網站是使用github頁面（分支gh-pages ）自動發行的CI。

每當Master上發生更改時，如果成功創建了構建，則將自動發佈在GitHub頁面上。

為了使此功能正常，需要正確配置Circle CI，以提供所有必要的環境變量：

• DOMAIN ：在GitHub頁面（ www.fastify.io ）中使用的自定義域
• GH_EMAIL ：在CircleCi授權的GITHUB用戶的電子郵件推入gh-pages分支機構
• GH_NAME ：GITHUB用戶在CircleCi授權推向gh-pages分支的用戶名
• GH_TOKEN ：（可選）github個人訪問令牌對於GH_NAME指定的用戶。如果存在，則將對GitHub的API調用進行身份驗證。
• CLOUDFLARE_EMAIL ：CloudFlare帳戶的電子郵件
• CLOUDFLARE_AUTH_KEY ：在CloudFlare API上執行API調用的授權鍵
• CLOUDFLARE_ZONE ：與當前域關聯的Cloudflare區域的ID

貢獻

非常歡迎每個人為這個項目做出貢獻。您可以僅通過提交錯誤或通過打開問題或發送拉動請求來提出改進來做出貢獻。

執照

根據MIT許可獲得許可。 ©OpenJS基金會和Fastify團隊。