Skip to content

About

Landing page of the Visual Geometry Toolkit: Julia packages for multi-view geometry

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

39 Commits

Folders and files

Repository files navigation

visualgeometrytoolkit.github.io

The landing page of the Visual Geometry Toolkit: Julia packages for multi-view geometry.

The landing page is plain static HTML, CSS and JavaScript; the Portal workflow places it at the root of the published site (see below). The ecosystem graph is rendered in the browser by a pinned mermaid release, and the package icons in icons/ are self-contained SVGs that switch between light and dark colours with prefers-color-scheme.

To preview locally: python -m http.server in this directory, then open http://localhost:8000.

Shared with the other toolkits' sites

This repository owns the landing-page tooling of every toolkit of the stack; another toolkit's site (the Visual Radiometry Toolkit's) takes these files from here at a pinned commit and keeps no copy:

File What
shared/base.css the palette, the page, the hero text, the ecosystem graph, the cards with their BibTeX toggle, the get-started blocks
shared/site.js the ecosystem graph's rendering, the BibTeX copy buttons, the helpers a title banner's script uses (stackSite)
tools/stack_icons.py the icon tile: its style, svg, arrow, write_icons
tools/stack_social_card.py the link-preview card: social_card
tools/pixi.toml, tools/pixi.lock the Python environment the generators run in
portal/stack_portal.jl, portal/Project.toml the documentation portal: the docs store, the navigation bar and the MultiDocumenter build (portal_pages, portal_docs, make_portal), and its environment
icons/vgt_logo.svg, icons/radiometric.svg the canonical copies of the icons other sites show

index.html links shared/base.css and then style.css, and loads shared/site.js and then main.js: style.css and main.js hold only what is this site's own (its title banner). A change to a shared file reaches another site when that site moves its pin, so it is tested there first.

Regenerating the icons

icons/ is generated by tools/make_icons.py; do not edit the SVGs by hand. The drawn icons are defined in the script (on the stack's tile, tools/stack_icons.py). The LocalOptimizationDoneRight, RANSACScoringDoneRight and BlobBoards icons are crops of those projects' landing heroes, read from checkouts under ~/src (override with VGT_SRC; the RANSACScoringDoneRight checkout is the directory RansacScoringDoneRight.jl): <repo>/docs/src/assets/landing/hero_*.png. BlobBoards' hero is itself generated by docs/make_hero.jl in BlobBoards.jl (its configuration is recorded beside it in docs/hero_board.json).

cd tools
pixi run icons        # pixi.toml + pixi.lock pin Python and Pillow

icons/radiometric.svg (Real Cameras are Radiometric, a publication card) is hand-written in the same style and is not produced by the script.

Package documentation

.github/workflows/portal.yml builds the published site: this landing page at the root, plus the six monorepo packages' Documenter sites, from VisualGeometryToolkit.jl's gh-pages, aggregated by MultiDocumenter (portal/make.jl) under /<Package>/. RANSACScoringDoneRight, LocalOptimizationDoneRight and BlobBoards keep their docs on their own project sites (<project>.github.io); the portal links to them, and their old /<Project>/ paths are redirect pages. The landing page links each monorepo package's own Documenter site, https://visualgeometrytoolkit.github.io/VisualGeometryToolkit.jl/<Package>/stable/, and PanoramaStitching's at https://visualgeometrytoolkit.github.io/PanoramaStitching.jl/dev/. The Portal workflow runs on push, nightly, by hand, and on the docs-updated repository_dispatch from the monorepo's Docs workflow. Pages is served from the workflow (source: GitHub Actions), not from main.

About

Landing page of the Visual Geometry Toolkit: Julia packages for multi-view geometry

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages