Skip to content

glx view

Generate a browsable static HTML site from an archive

Synopsis

Export a GLX archive as a self-contained static HTML site for sharing with family who won't install tools or read YAML.

The site includes a person profile page for everyone in the archive (with vital facts, a life timeline, linked family members, supporting sources, and a media gallery), plus source and place indexes and a client-side search. The output is a plain directory of HTML/CSS/JS with no server, database, or build tooling required — open index.html directly with file:// or host it anywhere (GitHub Pages, S3, Netlify).

Use --serve to preview the site locally over HTTP. Use --living to redact people who are likely still alive before publishing; it applies the same rules as export --privatize-living: a person is treated as living when their living: true property is set, or — under the fallback heuristic — when no recorded death, burial, or cremation event exists (regardless of whether the event has a date) and their most recent known birth year is less than 100 years ago. Use --embed-media to inline images as base64 for a fully self-contained set of pages.

glx view [flags]

Examples

  # Generate a site in ./site
  glx view --archive . --output ./site

  # Generate and preview locally
  glx view --serve

  # Redact living people and embed media for sharing
  glx view --output ./public --living --embed-media

  # Custom site title
  glx view --output ./site --title "The Webb Family Archive"

Options

  -a, --archive string   Archive path (directory or single file) (default ".")
      --embed-media      Embed images as base64 for fully self-contained pages
  -h, --help             help for view
      --living           Redact living persons (explicit living: true, or no death/burial/cremation event and born <100 years ago)
  -o, --output string    Output directory for the generated site (default "./site")
      --port int         Port for --serve (default 8080)
      --serve            Serve the generated site locally over HTTP
      --title string     Site title (default "GLX Family Archive")

Options inherited from parent commands

  -q, --quiet   Suppress non-error output (where supported)

SEE ALSO

  • glx - GENEALOGIX CLI - Manage and validate genealogy archives

Licensed under Apache License 2.0