安裝 Astro
create astro CLI 指令是從零開始一個新 Astro 專案最快的方法。它會引導你完成設定新 Astro 專案的每個步驟,並讓你從幾個不同的官方起始模板中選擇。
你也可以加上 template 選項來執行 CLI 指令,以使用任何現有的主題或起始模板來開始你的專案。探索我們的主題和起始模板展示,你可以在那裡瀏覽部落格、作品集、文件網站、登陸頁面等主題!
如果你想手動安裝 Astro,請參閱我們的手動安裝指南。
想在瀏覽器中試用 Astro 嗎?前往 astro.new 瀏覽我們的起始模板,並在不離開瀏覽器的情況下建立新的 Astro 專案。
- Node.js -
v22.12.0或更高版本。不支援奇數版本,像是v23。 - 文字編輯器 - 我們推薦使用 VS Code 搭配我們的官方 Astro 擴充功能。
- 終端機 - Astro 是透過命令列介面(CLI)來使用的。
瀏覽器相容性
Section titled “瀏覽器相容性”Astro 是使用 Vite 建構的,預設支援具有現代 JavaScript 功能的瀏覽器。完整的參考資料,請參閱 Vite 目前支援的瀏覽器版本清單。
從 CLI 精靈安裝
Section titled “從 CLI 精靈安裝”你可以在電腦的任何地方執行 create astro,所以在開始之前不需要為你的專案建立新的空目錄。如果你還沒有為新專案準備空目錄,CLI 精靈會自動幫你建立一個。
-
在終端機中執行以下指令來啟動安裝精靈:
終端機視窗 # 使用 npm 建立新專案npm create astro@latest終端機視窗 # 使用 pnpm 建立新專案pnpm create astro@latest終端機視窗 # 使用 yarn 建立新專案yarn create astro如果一切順利,你會看到成功訊息,然後是一些建議的後續步驟。
-
現在你的專案已經建立,你可以
cd進入新的專案目錄來開始使用 Astro。 -
如果你在 CLI 精靈過程中跳過了「Install dependencies?」的步驟,請務必在繼續之前安裝相依套件。
終端機視窗 npm install終端機視窗 pnpm install終端機視窗 yarn install -
你現在可以啟動 Astro 開發伺服器並在建構時看到專案的即時預覽!
CLI 安裝選項
Section titled “CLI 安裝選項”你可以在執行 create astro 指令時加上額外選項以自訂設定過程(例如對所有問題回答「是」、跳過 Houston 動畫)或你的新專案(例如是否安裝 git、新增整合)。
你可以在啟動新 Astro 專案的同時,在 create astro 指令中傳遞 --add 參數來安裝任何官方整合 (EN)或支援 astro add 指令的社群整合。
在你的終端機中執行以下指令,替換為任何支援 astro add 指令的整合:
# 建立具有 React 和 Partytown 的新專案npm create astro@latest -- --add react --add partytown# 建立具有 React 和 Partytown 的新專案pnpm create astro@latest --add react --add partytown# 建立具有 React 和 Partytown 的新專案yarn create astro --add react --add partytown使用主題或起始模板
Section titled “使用主題或起始模板”使用 create astro 命令時,你可以加上 --template 參數來基於官方範例或任何 GitHub 儲存庫的 main 分支建立新的 Astro 專案。
在你的終端機中執行以下指令,將官方的 Astro 模板名稱或你想使用的主題的 GitHub 使用者名稱和儲存庫名稱替換進去:
# 使用官方範例建立新專案npm create astro@latest -- --template <example-name>
# 基於 GitHub 儲存庫的 main 分支建立新專案npm create astro@latest -- --template <github-username>/<github-repo># 使用官方範例建立新專案pnpm create astro@latest --template <example-name>
# 基於 GitHub 儲存庫的 main 分支建立新專案pnpm create astro@latest --template <github-username>/<github-repo># 使用官方範例建立新專案yarn create astro --template <example-name>
# 基於 GitHub 儲存庫的 main 分支建立新專案yarn create astro --template <github-username>/<github-repo>預設情況下,此指令會使用模板儲存庫的 main 分支。若要使用不同的分支名稱,請將其作為 --template 參數的一部分傳遞:<github-username>/<github-repo>#<branch>。
本指南將帶你逐步手動安裝和設定新的 Astro 專案。
如果你不想使用我們的自動化 create astro CLI 工具,可以按照以下指南自行設定專案。
-
建立你的目錄
建立一個以你的專案名稱命名的空目錄,然後進入該目錄。
終端機視窗 mkdir my-astro-projectcd my-astro-project進入新目錄後,建立專案的
package.json檔案。這是你管理專案相依套件(包括 Astro)的方式。如果你不熟悉這個檔案格式,請執行以下指令來建立一個。終端機視窗 npm init --yes終端機視窗 pnpm init終端機視窗 yarn init --yes -
安裝 Astro
首先,在專案內安裝 Astro 專案相依套件。
Astro 必須在本地安裝,而非全域安裝。請確保你沒有執行
npm install -g astro、pnpm add -g astro或yarn add global astro。終端機視窗 npm install astro終端機視窗 pnpm add astro終端機視窗 yarn add astro然後,將
package.json中任何佔位符的 “scripts” 區段替換為以下內容:package.json {"scripts": {"test": "echo \"Error: no test specified\" && exit 1","dev": "astro dev","build": "astro build","preview": "astro preview"},}你將在本指南後續步驟中使用這些腳本來啟動 Astro 並執行其不同的指令。
-
建立你的第一個頁面
在文字編輯器中,於目錄的
src/pages/index.astro建立新檔案。這將是專案中你的第一個 Astro 頁面。在本指南中,複製並貼上以下程式碼片段(包括
---虛線)到新檔案中:src/pages/index.astro ---// 歡迎來到 Astro!三重虛線程式碼圍欄之間的所有內容// 都是你的「元件 frontmatter」。它永遠不會在瀏覽器中執行。console.log('這會在你的終端機中執行,而不是瀏覽器!');---<!-- 以下是你的「元件模板」。它只是 HTML,但加入了一些魔法來幫助你建構出色的模板。 --><html><body><h1>Hello, World!</h1></body></html><style>h1 {color: orange;}</style>