Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion website/.prettierignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
dist
node_modules
package-lock.json
pnpm-lock.yaml
41 changes: 26 additions & 15 deletions website/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ The landing page for [vump](https://github.com/okcodes/vump). One page, built
to static files and destined for GitHub Pages.

```bash
npm install
npm run dev # http://localhost:5173
npm run check # typecheck, lint, format, build — what CI will run
pnpm install
pnpm dev # http://localhost:5173
pnpm check # typecheck, lint, format, build — what CI will run
```

| Script | Does |
Expand All @@ -24,17 +24,27 @@ npm run check # typecheck, lint, format, build — what CI will run

| Path | Holds |
| -------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
| `src/content/` | Every fact the page states: terminal runs, tracked files, version rules, exit codes, links. Nothing here renders. |
| `src/components/sections/` | One file per numbered section, in page order. |
| `src/content/` | Every fact the page states: terminal runs, tracked files, snippets, links. Nothing here renders. |
| `src/components/sections/` | One file per section, in page order. |
| `src/components/ui/` | The primitives: terminal pane, code block, section frame, reveal, buttons. |
| `src/lib/` | Hooks and the two small engines — a segment model for command output, and a highlighter for the four snippet languages. |
| `src/index.css` | The whole design system: palette, type, motion. |
| `scripts/og.mjs` | Renders the social card from the same values, offline. |

**Content is separate from layout on purpose.** Every terminal pane on the page
reproduces what the binary actually prints — the marks, the column alignment,
the wording of the errors. When vump's output changes, `src/content/runs.ts` is
the only file to revisit.
## What this page is for

It introduces vump to someone who has never seen it: what it does, whether it
handles their files, and how to start. That is all.

**It does not restate the documentation.** No flag tables, no exit codes, no
configuration reference, no design rationale — those live in the repository and
are linked from here. Anything copied onto this page is a second copy to keep
true, and the page is not worth that.

**Content is separate from layout on purpose.** Every terminal pane reproduces
what the binary actually prints — the marks, the column alignment, the wording
of the errors. When vump's output changes, `src/content/runs.ts` is the only
file to revisit.

**The page states no version number.** The release chip fetches the newest
release from the GitHub API as the page loads, and renders nothing when that
Expand All @@ -53,8 +63,8 @@ Terminal surfaces are held dark in both themes. Rendered command output should
read as output, not as a styled quotation.

The accent is spent on one thing: what changed. A new version number, a passing
mark, a highlighted line in a snippet. Amber marks a refusal, red a failure, and
nothing else is coloured at all.
mark, a highlighted line in a snippet. Red marks a failure, and nothing else is
coloured at all.

## Lint configuration

Expand Down Expand Up @@ -115,13 +125,14 @@ jobs:
working-directory: website
steps:
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v4
- uses: actions/setup-node@v4
with:
node-version: 24
cache: npm
cache-dependency-path: website/package-lock.json
- run: npm ci
- run: npm run check
cache: pnpm
cache-dependency-path: website/pnpm-lock.yaml
- run: pnpm install --frozen-lockfile
- run: pnpm check
- uses: actions/upload-pages-artifact@v3
with:
path: website/dist
Expand Down
8 changes: 4 additions & 4 deletions website/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />

<title>vump — one version, every file, proven at the tag</title>
<title>vump — one version, every file, one command</title>
<meta
name="description"
content="vump keeps every version number in a repository in step, and fails the build before a tag that disagrees with its source can cost you anything."
content="vump writes your new version into package.json, Cargo.toml, pyproject.toml and their lock files at once — then commits, tags, and verifies the tag in CI."
/>
<link rel="canonical" href="%VITE_SITE_URL%/" />

Expand All @@ -18,7 +18,7 @@

<meta property="og:type" content="website" />
<meta property="og:site_name" content="vump" />
<meta property="og:title" content="vump — one version, every file, proven at the tag" />
<meta property="og:title" content="vump — one version, every file, one command" />
<meta
property="og:description"
content="Keep every version number in a repository in step, and fail the build before a tag that disagrees with its source can cost you anything."
Expand All @@ -28,7 +28,7 @@
<meta property="og:image:width" content="1200" />
<meta property="og:image:height" content="630" />
<meta name="twitter:card" content="summary_large_image" />
<meta name="twitter:title" content="vump — one version, every file, proven at the tag" />
<meta name="twitter:title" content="vump — one version, every file, one command" />
<meta
name="twitter:description"
content="Keep every version number in a repository in step, and fail the build before a tag that disagrees with its source can cost you anything."
Expand Down
Loading