Module

cli.templates.default.template

Default site template.

This module defines the minimal starter template shipped with Bengal. It creates a singlecontent/index.mdfile so users can bootstrap a site with one command, and serves as a reference implementation for custom templates.

Exported objects:

  • TEMPLATE: the concreteSiteTemplate instance discovered by the template registry.
View source
2 Functions

Functions

_load_template_file
Load a static page stub bundled with this template.
1 str 
def _load_template_file(relative_path: str) -> str

Load a static page stub bundled with this template.

Parameters 1

Name Type Default Description
relative_path str —

Path inside this template'spages/directory.

Returns

str —

The raw file contents for inclusion in a :class:TemplateFile.

_create_default_template
Construct the default site template definition. The template provisions a single welcome page at `…
0 SiteTemplate 
def _create_default_template() -> SiteTemplate

Construct the default site template definition.

The template provisions a single welcome page atcontent/index.md.

Returns

SiteTemplate —

A fully populated :class:SiteTemplateinstance.