Skip to content
VectorHub Docs

GitHub Pages

The portal is configured for static output and can be deployed to GitHub Pages.

Build variables

Section titled “Build variables”

Use:

  • SITE: the GitHub Pages origin, for example https://otimizai-tech.github.io
  • BASE_PATH: the repository path, for example /VectorHub/

Example:

Terminal window
SITE=https://otimizai-tech.github.io BASE_PATH=/VectorHub/ npm run build

The package also includes:

Terminal window
npm run build:github

By default, build:github uses:

SITE=https://otimizai-tech.github.io
BASE_PATH=/VectorHub/

Override those variables if the repository name or organization changes.

Why BASE_PATH matters

Section titled “Why BASE_PATH matters”

GitHub Pages project sites are usually served below a repository path. The portal uses Astro base so links and the Scalar OpenAPI URL continue working below that path.

Static assets

Section titled “Static assets”

The public/.nojekyll file is included so GitHub Pages serves Astro assets under _astro.