1. CLI Command (Full Example)

Deprecated Async

`bengal build`

Build the static site from source content. This command processes all markdown files, applies templates, and generates the final HTML output.

12 Options 2 Arguments

View source

Usage

bengal build [OPTIONS] [SOURCE]

Options

Name	Type	Default	Description
`--source`	`Path`	`./content`	Source directory containing content files.
`--output`	`Path`	`./public`	Output directory for generated site.
`--parallel`	`bool`	`True`	Enable parallel processing for faster builds.

Examples

Basic usage

bengal build

With custom output directory

bengal build --output ./dist

2. Python Class

Dataclass

`bengal.core.Site`

Central site container that holds all pages, sections, and configuration.

class Site:
    pages: list[Page]
    sections: dict[str, Section]
    config: SiteConfig

Parameters

root Path: Root directory of the site content. Default: Path(".")
config SiteConfig | None: Site configuration. If not provided, will be loaded from bengal.toml.

Attributes

Name	Type	Description
`pages`	`list[Page]`	All pages in the site.
`sections`	`dict[str, Section]`	Section lookup by path.

Methods

render (page: Page) → str async

Render a page to HTML string.

page Page: The page to render.

validate () → ValidationResult

Validate site configuration and content.

3. Python Function

`bengal.build`

Build the site from source content to output directory.

def build(
    source: Path,
    output: Path,
    parallel: bool = True,
    incremental: bool = False
) -> Site

Returns

Site The built site instance with all rendered pages.

Raises

ConfigurationError: When configuration file is invalid or missing.
BuildError: When build process fails due to template or content errors.

4. CLI Command Group (Cards)

`bengal`

Bengal Static Site Generator - A powerful and flexible SSG.

Subcommands

build Build the static site from source content. serve Start development server with live reload. watch Watch for changes and rebuild automatically. new Create a new site or content file.

5. OpenAPI Endpoint

GET `/api/v1/users`

List all users with optional filtering and pagination.

Query Parameters

Name	Type	Default	Description
`page`	`integer`	`1`	Page number for pagination.
`limit`	`integer`	`20`	Maximum number of users to return.

Related Endpoints

POST /api/v1/users Create a new user. GET /api/v1/users/{id} Get user by ID. PUT /api/v1/users/{id} Update user by ID. DELETE /api/v1/users/{id} Delete user by ID. PATCH /api/v1/users/{id} Partially update user.

6. All Badge Types

Deprecated Async Abstract Dataclass Required Default

`Badge Showcase`

7. API Cards with Status Dots (Preferred Design)

Container for parsed docstring data.

Methods 1

Convert to dictionary representation.

Internal Methods 1 ▼

Initialize the parsed docstring.

Parse Google-style docstrings.

Parse NumPy-style docstrings.

Parse Sphinx-style docstrings.

Functions

Parse docstring and extract structured information.

Auto-detect docstring style.

Autodoc CSS Skeleton Test