Skip to content

Link format

v8s-links.txt is the human-authored source of truth for links. Each non-empty, non-comment row is pipe-delimited:

slug|target|state|title|description|tags|owner|expires_at|notes
FieldRequiredDescription
slugyesSlash-delimited alias path, without leading /
targetyesAbsolute http or https URL, or a hostname normalized to https://
statenopermanent, ephemeral, expired, disabled, maintenance, deactivated
titlenoDashboard title
descriptionnoHuman-readable purpose
tagsnoComma-separated tags
ownerrecommendedAccountability label
expires_atnoISO date or timestamp
notesnoInternal notes
social/x|https://x.com/vanityURLs|permanent|X / Twitter|Social profile|social,x|v8s||

The link resolves only /social/x.

Append /* to the slug and include :splat in the target:

github/*|https://github.com/vanityURLs/:splat|permanent|GitHub|Repo namespace|git|v8s||

/github/website redirects to https://github.com/vanityURLs/website.

States

StateRuntime behavior
permanent301 to the link target
ephemeral302 to the link target
expired302 to /expired
disabled302 to /disabled
maintenance302 to /maintenance
deactivatedtrue 404

If expires_at is earlier than the current time, the effective state becomes expired.

Slug rules

  • No leading or trailing slash
  • No empty segment
  • No query string or fragment
  • Each segment starts with a letter or digit
  • Segment characters can include letters, digits, ., _, ~, and -

Reserved top-level slugs include admin, 404, expired, disabled, maintenance, deactivated, assets, and v8s.json.

Edit this page Last modified: