Module

core

Core domain models for Bengal SSG.

This package contains the foundational data models that represent the content structure of a Bengal site:

Data Models:

  • Page: Individual content pages (complex model with mixins)
  • Section: Content groupings and hierarchy
  • Site: Top-level site container
  • Asset: Static assets (CSS, JS, images)
  • Menu: Navigation menus

Organization Pattern:

  • Simple models (< 400 lines): Single file (e.g., section.py)

  • Complex models (> 400 lines): Package (e.g., page/)

    When a model grows beyond 400 lines or requires multiple concerns, it should be converted to a package with focused modules/mixins.

Architecture:

Core models are passive data structures with computed properties.
They do not perform I/O, logging, or side effects. Operations on
models are handled by orchestrators (see bengal/orchestration/).

Related:

  • Operations on models: bengal/orchestration/
  • Discovery of models: bengal/discovery/
  • Rendering of models: bengal/rendering/
  • Observability: Handled by orchestrators, not models

Example:

>>> from bengal.core import Site, Page
>>> site = Site(root_path=Path('.'))
>>> page = Page(source_path=Path('content/post.md'))
View source