Write the text. Get a project page.
A landing page for libraries, apps, and tools. Edit site.yaml. Then build a static page that GitHub Pages can host.
-
Add the project name, colors, and the sections you want. Skip the rest.
-
Put real screenshots in assets/ and link them from the page.
-
Run pnpm build. Open the docs/ folder on this machine, then push.
-
GitHub Actions publishes docs/ to GitHub Pages when you push to main.
Add the project name, colors, and the sections you want. Skip the rest.
-
GitHub Pages cannot host APIs, login, or private keys.
-
The github section reads api.github.com in the browser. Those counts are not stored in YAML.
-
Screenshots and commands must match the repo. The kit will not invent numbers or terminal output.
-
Image links are relative. A project site at /repo-name/ works without extra setup.
-
1
file to edit
-
5
presets
-
0
frameworks in the output
Repository
Public GitHub pulse.
Stars, activity, releases, and recent commits. The browser reads the public GitHub API.
-
—
Stars
-
—
Forks
-
—
Watching
-
—
Open issues
Activity
Weekly commits load from GitHub.
Demo
Three views. One page.
Click a tab to switch. These panels show real files from this kit.
Content
Output
Drop-in
Edit site.yaml
Name, colors, text, and section order live in one file. Empty sections do not show.
schema: gvaste-pages/v1preset: appproject: name: Example description: One sentence. repo: https://github.com/example/appsections: [hero, demo, docs, links]
Build writes docs/
The script fills the templates, copies images, and writes index.html plus styles.css. GitHub Actions uploads that folder.
pnpm build# docs/index.html# docs/styles.css# docs/assets/...
Copy into an existing repo
Copy kit/, scripts/build-site.mjs, and a site.yaml. Point Pages at the generated docs/ folder.
kit/scripts/build-site.mjssite.yamlpnpm build
Start here
Build the page.
Then run pnpm preview to open docs/ on your computer. For a new repo, use this GitHub template and replace the YAML.
Links
Open the source.
Repository, live site, sponsor, examples, playground, and the section catalog.