_config.yml

# GitHub Pages. The site exists so there is a URL Max owns for content to
# point at - the repo's website field pointed at the PyPI package page, which
# is a dead end for accumulated search authority.
#
# No separate landing copy: Jekyll falls back to README.md when there is no
# index, so the site renders the README that is already reviewed and already
# the front door. One source, one wording, nothing to keep in sync.
title: Compartment
theme: jekyll-theme-cayman

# The card shown when this URL is posted to X, Slack, Discord or anywhere
# else that reads Open Graph tags. Without it the link renders as a bare
# grey box. Absolute, because Open Graph consumers do not resolve relative
# paths. Regenerate with tools/make_social_card.py.
#
# It has to go through `defaults`, not a bare top-level `image:` key -
# jekyll-seo-tag reads page.image, so a site-level key is silently ignored
# and you get a page with no og:image and no sign of why.
defaults:
  - scope:
      path: ""
    values:
      image: https://raw.githubusercontent.com/MaxFreedomPollard/Compartment/main/docs/images/social-preview.png

twitter:
  card: summary_large_image

# Everything that is code, build machinery or packaging. Without this Jekyll
# walks the whole tree and publishes directory listings for src/ and tests/.
exclude:
  - src
  - tests
  - tools
  - packaging
  - install
  - integrations
  - build
  - dist
  - .venv
  - .github
  - pyproject.toml
  - server.json
  - glama.json
  - RELEASING.md