Files
horizon-airdef/website/README.md
T
Ludovic Marie fe5e20507a Website: docs match what ships (Mods page, shader packs page, dynamic lights, LAN workstations); the live ping is off
The Mods page (launcher 0.17) replaces "a mod browser is planned"; the Horizon
shader format is no longer called planned; Nightly-only things say Nightly.
The "I'm playing" ping has no server (DEFAULT_ENDPOINT is None), so the FAQ and
the privacy page say it is off instead of sent. The channel switch says it
needs the launcher release after 0.17. The README says what deploys the site.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-22 16:29:58 +02:00

109 lines
6.5 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Horizon's website
Live at **https://playhorizon.dev**.
A landing page and a documentation section in Horizon's design language (`docs/design-system.md`), with the tokens of
`crates/horizon-theme` (generated into `src/tokens.css` by `cargo run -p xtask -- tokens`):
Geist and Geist Mono, cool neutrals in a light and a dark appearance (the system's, or the
toggle's) and one violet accent, numbered index lists with one-pixel rules, and short, eased
motion. A headline and the download, then a scroll through what it is, the screenshots, the parity grid, the launcher, the patch
notes, the community links and the contributors. Plain HTML, CSS and JavaScript; no framework and
no runtime dependencies.
## Layout
```
build.mjs renders dist/ (no dependencies)
docs/*.md the documentation, one Markdown file per page: "# Title", a lede paragraph, then sections
docs/nav.json the order of the pages and the groups of the left navigation
serve.mjs a tiny static server for local checks
src/index.html the page, with {{placeholders}} build.mjs fills
src/404.html the not-found page
src/privacy.html what the launcher can send when players allow it, retention, deletion (/privacy)
src/docs.html the template of every documentation page (/docs/...), with its left navigation
src/tokens.css the design tokens, generated from crates/horizon-theme (do not edit)
src/style.css every style, on top of the tokens
src/main.js download buttons, patch notes, links, contributors, nav and menu, tabs, lightbox, motion
src/markdown.js a small Markdown renderer (escapes everything), shared by build and page
src/releases.js the patch notes' markup, shared by build and page
src/contributors.js the contributors' filtering and markup, shared by build and page
public/ fonts, screenshots, icons, og.png, robots.txt: copied as is (sitemap.xml is written by the build)
scripts/assets.mjs rebuilds public/ from the repo (fonts to WOFF2, images to WebP)
scripts/shots.mjs Playwright screenshots at every width, and og.png
Dockerfile, Caddyfile, railway.json the Railway service
LEGAL.md every asset, its source and licence
shots/ (gitignored) full-page screenshots at 360–1920 px, a 1250×700 window, the open phone menu
```
## What comes from where
- **Built in** (`build.mjs`): the parity table, its score, harness count and audit date,
all from `README.md`; the documentation pages (`/docs`) from `website/docs/`; the Discord and Sponsor links from
`launcher/links.json`; the latest releases and the contributors (`/repos/ludovic111/horizon/contributors`,
bots left out, the owner first), when GitHub answers; without an answer the build still succeeds and
the Contributors block and its menu entries stay hidden until the page loads them. Locally these come from
the checkout; on Railway, which builds only this folder, from `main` on GitHub. The build
fails if the README has no parity table, so a broken README never deploys.
- **Fetched by the page**: the releases (the download button picks the newest
`launcher-v*` release's asset for the visitor's OS, and the three latest game releases'
notes are rendered), the contributors (avatars come from `avatars.githubusercontent.com`),
and `links.json` from `main`. Each
falls back to what was built in, and the download button to the releases page.
## The documentation
`docs/<slug>.md` becomes `/docs/<slug>` (`index.md` is `/docs/`). Write for players first, then hosters,
then contributors; plain words, short paragraphs; claim only what players can download today, and
mark merged-but-unreleased things "next release". `{{HARNESSES}}` and `{{PERCENT}}` are filled from
the README. A line holding only `![caption](/media/...)` becomes a figure (the file must be in
`public/media/`); links to other pages are `/docs/<slug>#heading`. The build checks every link
between pages and every image, and fails with the list when one is broken. `/server`
redirects to `/docs/hosting`. The developer docs in the repository's `docs/` stay as they are and are linked from
the Contributing page.
## Run it locally
```sh
cd website
node build.mjs && node serve.mjs # http://localhost:4173
```
Asset and screenshot scripts need the dev dependencies (sharp, wawoff2, Playwright):
```sh
npm install
GITHUB_TOKEN=$(gh auth token) node build.mjs # optional token: bakes the releases past the API rate limit
npm run assets # after a font, screenshot or logo changes in the repo
npm run shots # shots/*.png (gitignored; SHOTS=dir to write elsewhere) and public/og.png
```
The screenshots are not committed: full-page PNGs at a dozen widths weigh about 17 MB.
Running text stays under 80 characters a line; on 360–430 px phones the narrowest paragraphs
fall to about 26–35, which is what that width allows. `npm run shots` also reports horizontal overflow, tap targets under 44 px on touch widths
and characters per line, for 360 to 1920 px wide and a 1250×700 window.
## Railway
The service deploys `main` (Railway's GitHub integration; there is no `website` branch any more) when `/website/**`, `README.md` or `launcher/links.json` change, and answers on https://playhorizon.dev. Its
`*.up.railway.app` address redirects there with a 301 (the Caddyfile), so search engines index
one URL; the page also names it as canonical, in its Open Graph tags and in `sitemap.xml`.
Railway's healthcheck reaches `$PORT` under its own host name and is served normally.
Create a service from the GitHub repo with **root directory `website`**. `railway.json`
selects the Dockerfile: a Node stage runs `build.mjs` (reading the README from `main`), and
a Caddy stage serves `dist/` on `$PORT` with compression, cache headers, a strict
Content-Security-Policy and the 404 page. Its watch patterns also redeploy when the README
or `launcher/links.json` change on main. No variables are needed; an optional
`GITHUB_TOKEN` (read-only, public repos) lets the build bake the releases even when
GitHub's anonymous rate limit is hit.
## Rules the site keeps
- The disclaimer, "Not an official Minecraft product. Not approved by or associated with
Mojang or Microsoft.", is under the headline, in the phone menu, the footer and the 404 page.
- No Minecraft logo or wordmark; "Minecraft" appears only descriptively ("for Minecraft:
Java Edition 26.3"). No game files are offered or linked.
- Parity is worded as the README words it: 100% of what the harnesses compare.
- No cookies, analytics, trackers or third-party fonts and scripts.
- Motion stops under `prefers-reduced-motion`; nothing hijacks the scroll.