betty.extensions.raspberry_mint package

Module contents

Provide the Raspberry Mint theme.

final class betty.extensions.raspberry_mint.Breakpoint

Bases: Enum

The theme’s breakpoints.

LG = 'lg'

MD = 'md'

SM = 'sm'

XL = 'xl'

XS = 'xs'

XXL = 'xxl'

final class betty.extensions.raspberry_mint.ColorStyle

Bases: Enum

The available color styles.

DARK = 'dark'

A dark style with a black background.

DARK_SECONDARY = 'dark-secondary'

A dark style with a dark shade of the secondary color for the background.

LIGHT = 'light'

A light style with a white background.

LIGHT_CONTRAST = 'light-contrast'

A light style with a light shade of gray for the background.

LIGHT_SECONDARY = 'light-secondary'

A light style with a light shade of the secondary color for the background.

final class betty.extensions.raspberry_mint.JustifyContent

Bases: Enum

How to justify content.

AROUND = 'around'

BETWEEN = 'between'

CENTER = 'center'

END = 'end'

EVENLY = 'evenly'

START = 'start'

final class betty.extensions.raspberry_mint.RaspberryMint

Bases: DataManufacturable[RaspberryMintData], Manufacturable, Generator, EntryPointProvider, ServiceProvider

The raspberry-mint extension plugin.

Plugin ID	raspberry-mint
Class	RaspberryMint
Configuration	RaspberryMintData

Important

This extension requires Node.js.

Regions

Raspberry Mint provides the following regions contents may be configured for:

• front-page-content The main content for the front page.

• front-page-summary The page summary for the front page.

• entity-page-content The page content region for entity pages.

• entity-page-content--{entity_type_id} The page content region for entity pages of a specific public-facing entity type, where {entity_type_id} is the entity type ID. If no content is assigned to this region for an entity type, entity-page-content is used instead.

DEFAULT_PRIMARY_COLOR: Final[str] = '#b3446c'

DEFAULT_SECONDARY_COLOR: Final[str] = '#3eb489'

DEFAULT_TERTIARY_COLOR: Final[str] = '#ffbd22'

__init__(*, project: Project, primary_color: str | None = None, regional_content: RegionalContentManufacturers | None = None, secondary_color: str | None = None, tertiary_color: str | None = None)

async generate(scheduler: Scheduler) → None

Generate (part of) a project’s site.

new = <betty.requirement._RequirableDecorator object>

classmethod new_data_cls() → type[RaspberryMintData]

The object’s defined data class.

primary_color: Final[str]

The primary color.

regional_content

The regional content.

secondary_color

The secondary color.

tertiary_color

The tertiary color.

webpack_entry_point_cache_keys() → Sequence[str]

Get the keys that make a Webpack build for this provider unique.

Providers that can be cached regardless may return ().

classmethod webpack_entry_point_directory() → StrPath

Get the path to the directory with the entry point assets.

The directory must include at least a package.json and main.ts.

final class betty.extensions.raspberry_mint.RaspberryMintData

Bases: Data, HasProps

Configuration for the betty.extensions.raspberry_mint.RaspberryMint extension.

betty.extensions.raspberry_mint:RaspberryMintData

__init__(*, primary_color: str | None = None, secondary_color: str | None = None, tertiary_color: str | None = None, regional_content: Mapping[ResolvableRegion, Iterable[ResolvablePluginManufacturer[ContentBuilderDefinition, ContentBuilder]]] | None = None)

primary_color

The primary color.

regional_content

The regional content.

secondary_color

The secondary color.

tertiary_color

The tertiary color.

async validate(project: Project, /) → None

Validate the configuration.

final class betty.extensions.raspberry_mint.Region

Bases: Enum

The available regions.

ENTITY_PAGE_CONTENT = 'entity-page-content'

FRONT_PAGE_CONTENT = 'front-page-content'

FRONT_PAGE_SUMMARY = 'front-page-summary'

async classmethod all(project: Project, /) → Collection[str]

The available regions.

classmethod resolve(region: ResolvableRegion) → str

Resolve a region to its string name.