倉庫靜態落地頁 是做什麼的?
為所放置的儲存庫產生一個靜態著陸頁(docs/index.html + docs/style.css + docs/main.js),其內容來自該儲存庫。切勿列出儲存庫中實際上不存在的功能、提供者或指令。
內容的真實來源
在開始撰寫任何內容之前,請先閱讀以下內容:
README.*— 概述、功能、技術棧、安裝/快速入門指令LICENSE*— 授權名稱、版本、URLCHANGELOG.*— 變更歷史摘要package.json、composer.json、requirements.txt等:名稱、描述、依賴項(技術棧徽章的基礎)AGENTS.md、CLAUDE.md、config.toml、GEMINI.md等:專案的目的,如果專案有的話,還有支援的提供者/設定表格- 現有的
docs/index.html(如果存在的話):除非明確要求重新設計,否則請重複使用其章節結構,並就地編輯內容,而不是從頭開始重建
必要元素
-
淺色/深色主題 — 使用
prefers-color-scheme: dark媒體查詢覆寫 CSS 自訂屬性(--bg、--text、--accent等)。除非要求,否則不要加入 JS 主題切換按鈕。 -
OGP + Twitter/X 卡片 —
og:title、og:description、og:url、og:image、og:type、og:site_name、twitter:card、twitter:title、twitter:description、twitter:image。將og:image/twitter:image指向儲存庫中實際存在的資產(例如social-preview.png)。如果不存在,請先使用make-social-preview技能產生一個。 -
JSON-LD 結構化資料 — 一個
<script type="application/ld+json">區塊(對於應用程式/工具使用SoftwareApplication;否則使用任何符合專案的@type)。保持與 OGP 描述一致。 -
網站圖示 — 使用
<link rel="icon">引用一個適合該專案的 Twemoji SVG。 -
透過
multilanguagejs(CDN,無建置步驟)支援多國語言:<script src="https://unpkg.com/[email protected]/dist/multilanguagejs.umd.cjs"></script>將每個要翻譯的元素包裹在
<template type="language-group">中,並在其中為每種語言放置一個子元素,每個子元素帶有language="xx"屬性(不是lang):<h2> <template type="language-group"> <span language="en">Features</span> <span language="ja">機能</span> </template> </h2>每個
template[type=language-group]必須恰好包含每個支援語言一個元素 —multilanguagejs會為每個模板選取第一個符合的[language=X],因此重複會導致內容被靜默遺失。在
main.js中初始化它:var ml = new MultilanguageJS({ languages: [...], defaultLanguage: "en" }); ml.setLanguage(lang); // 載入時,以及 <select> 切換器的變更事件發生時<title>和<meta name="description">在[language]模板的範圍之外(該函式庫只會更新匹配元素的textContent,而<meta>標籤的翻譯存在於其content屬性中,而不是其文字)。在main.js中提供一個小型、每種語言的{ title, description }字典,並在ml.setLanguage()旁手動更新這兩個標籤。從
navigator.language偵測訪客的語言,將選定的語言儲存在localStorage中,並在載入時重新套用,然後再回退到瀏覽器偵測。必需的語言集(始終如此,無論應用程式本身支援什麼): 英文 (
en)、日文 (ja)、中文 (zh)、西班牙文 (es)、俄文 (ru)、德文 (de) — 至少 6 種語言。即使src/locales/*.json或應用程式自己的i18n.ts/i18n.js只涵蓋其中一部分(例如,即使對於只支援en/ja的應用程式,也要讓著陸頁支援 6 種語言)。如果需要,您可以將其他語言加入這 6 種語言中。 -
複製到剪貼簿按鈕 — 為
<code>區塊中顯示的每個安裝/執行指令提供一個複製按鈕,使用內聯 SVG 圖示(絕不使用表情符號),並透過navigator.clipboard.writeText()提供勾選標記確認狀態。為了保持佈局一致,請將<code>及其按鈕包裹在.code-row彈性容器中。 -
響應式 — 行動優先。避免在窄視口上造成水平捲動,除非在明確設計為可捲動的容器內(例如寬的比較表格)。
-
無建置步驟 — 讓頁面只需開啟 HTML 檔案或直接提供靜態資料夾即可運作,無論應用程式本身使用哪個打包工具(Vite 等)。保持
main.js為可讀取的原始碼。使用<script src="main.js">直接在頁面中載入它。 -
語意結構 — 以語意方式結構化這些內容:英雄區塊(標題、導引文字、行動呼籲按鈕、主要執行指令)、螢幕截圖(如果有的話,重複使用現有的儲存庫/GitHub 資源 URL)、功能網格、快速入門/安裝指令、技術棧徽章、頁尾。
-
重複使用現有的 CSS — 重複使用儲存庫的
docs/style.css中已有的 CSS 自訂屬性和類別名稱,而不是建立一個平行、獨立的樣式系統。 -
尊重設計系統 — 尊重現有 AI 代理執行時期環境中的設計系統。在加入新的 CSS 時,重複使用現有的自訂屬性和類別名稱,並遵循與儲存庫設計系統一致的命名慣例、設計、佈局以及語氣和風格。
工作流程
- 閱讀上述的內容來源。
- 如果
docs/不存在,則建立它。 - 如果
docs/index.html已存在,則就地編輯它 — 除非明確要求重新設計,否則不要全部替換;保留章節結構並更新內容。 - 以語意方式結構化章節:英雄區塊(標題、導引文字、行動呼籲按鈕、主要執行指令)、螢幕截圖(如果有的話,重複使用現有的儲存庫/GitHub 資源 URL)、功能網格、比較/設定表格(如果專案有多個值得比較的提供者/模式/後端)、快速入門/安裝指令、技術棧徽章、頁尾。
- 重複使用儲存庫的
docs/style.css中已有的 CSS 自訂屬性和類別名稱,而不是建立一個平行、獨立的樣式系統。 - 更新
docs/main.js。 - 在完成前驗證:互動式圖示未使用表情符號(僅限 SVG);每個
template[type=language-group]恰好包含每個支援語言一個子元素,沒有重複或遺漏;OGP/JSON-LD 指向儲存庫中實際存在的檔案/URL。