What does Static repo landing page do?
Generate a static landing page (docs/index.html + docs/style.css + docs/main.js) whose content is drawn from the repository it is placed in. Never list features, providers, or commands that do not actually exist in the repository.
Source of Truth for Content
Before writing anything, read the following:
README.*— overview, features, tech stack, install/quick-start commandsLICENSE*— license name, version, URLCHANGELOG.*— summary of the change historypackage.json,composer.json,requirements.txt, etc.: name, description, dependencies (the basis for tech stack badges)AGENTS.md,CLAUDE.md,config.toml,GEMINI.md, etc.: the project's purpose and, if the project has them, tables of supported providers/settings- An existing
docs/index.html(if present): unless explicitly asked for a redesign, reuse its section structure and edit the content in place rather than rebuilding from scratch
Required Elements
-
Light/dark theme — Override CSS custom properties (
--bg,--text,--accent, etc.) with aprefers-color-scheme: darkmedia query. Do not add a JS theme toggle unless asked. -
OGP + Twitter/X card —
og:title,og:description,og:url,og:image,og:type,og:site_name,twitter:card,twitter:title,twitter:description,twitter:image. Pointog:image/twitter:imageto an asset that already actually exists in the repository (e.g.,social-preview.png). If none exists, generate one first with themake-social-previewskill. -
JSON-LD schema — A
<script type="application/ld+json">block (SoftwareApplicationfor an app/tool; otherwise any@typethat fits the project). Keep it consistent with the OGP description. -
Favicon — Reference a Twemoji SVG that suits the project with
<link rel="icon">. -
Multilingual support via
multilanguagejs(CDN, no build step):<script src="https://unpkg.com/[email protected]/dist/multilanguagejs.umd.cjs"></script>Wrap every element to be translated in
<template type="language-group">, and inside it place one child element per language, each with alanguage="xx"attribute (notlang):<h2> <template type="language-group"> <span language="en">Features</span> <span language="ja">機能</span> </template> </h2>Each
template[type=language-group]must contain exactly one element per supported language —multilanguagejstakes the first matching[language=X]per template, so duplicates cause content to be silently lost.Initialize it in
main.js:var ml = new MultilanguageJS({ languages: [...], defaultLanguage: "en" }); ml.setLanguage(lang); // on load, and on the change event of the <select> switcher<title>and<meta name="description">are outside the scope of the[language]templates (the library only updates thetextContentof matching elements, and the translation of a<meta>tag lives in itscontentattribute, not its text). Givemain.jsa small per-language{ title, description }dictionary and update these two tags manually alongsideml.setLanguage().Detect the visitor's language from
navigator.language, save the selected language inlocalStorage, and on load reapply it before falling back to browser detection.Required language set (always, regardless of what the app itself supports): English (
en), Japanese (ja), Chinese (zh), Spanish (es), Russian (ru), German (de) — at least 6 languages. This applies even ifsrc/locales/*.jsonor the app's owni18n.ts/i18n.jscovers only some of them (e.g., even for anen/ja-only app, make the landing page in 6 languages). If requested, you may add other languages to these 6. -
Copy-to-clipboard buttons — Give every install/run command shown in a
<code>block a copy button with an inline SVG icon (never an emoji), with a checkmark confirmation state vianavigator.clipboard.writeText(). For consistent layout, wrap the<code>and its button in a.code-rowflex container. -
Responsive — Mobile-first. Do not cause horizontal scrolling on narrow viewports, except inside containers explicitly intended to scroll (e.g., a wide comparison table).
-
No build step — Make the page work just by opening the HTML file or serving the static folder as-is, regardless of which bundler (Vite, etc.) the app itself uses. Keep
main.jsas readable source. Load it directly in the page with<script src="main.js">. -
Semantic structure — Structure these semantically: hero (heading, lead text, CTA, primary run command), screenshots (reuse existing repository/GitHub asset URLs if any), feature grid, quick-start/install commands, tech stack badges, footer.
-
Reuse existing CSS — Reuse the CSS custom properties and class names already in the repository's
docs/style.cssrather than creating a parallel, separate styling system. -
Respect the design system — Respect the design system in the existing AI agent runtime environment. When adding new CSS, reuse existing custom properties and class names, and follow naming conventions, design, layout, and tone and manner consistent with the repository's design system.
Workflow
- Read the content sources above.
- If
docs/does not exist, create it. - If
docs/index.htmlalready exists, edit it in place — unless explicitly asked for a redesign, do not replace it wholesale; keep the section structure and update the content. - Structure the sections semantically: hero (heading, lead text, CTA, primary run command), screenshots (reuse existing repository/GitHub asset URLs if any), feature grid, comparison/settings table (if the project has multiple providers/modes/backends worth comparing), quick-start/install commands, tech stack badges, footer.
- Reuse the CSS custom properties and class names already in the repository's
docs/style.cssrather than creating a parallel, separate styling system. - Update
docs/main.js. - Verify before finishing: no emoji are used for interactive icons (SVG only); every
template[type=language-group]has exactly one child element per supported language, with no duplicates or omissions; OGP/JSON-LD point to files/URLs that actually exist in the repository.