bengal 0.1.5

A high-performance static site generator with modular architecture

Bengal

A high-performance static site generator for Python 3.14+

pip install bengal
bengal new site mysite && cd mysite && bengal serve

---

Why Bengal?

• Fast — Parallel builds, incremental rebuilds, Zstandard-compressed caching
• Modern — Python 3.14+ with free-threading support, fully typed
• Batteries included — Auto-generated API docs, content validation, site analysis
• Extensible — Remote content sources, custom directives, flexible theming

---

Quick Commands

Command	Description
bengal build	Production build
bengal serve	Dev server with live reload
bengal validate	Health checks and validation
bengal fix	Auto-fix common issues
bengal graph report	Site structure analysis

Aliases: b (build), s (serve), v (validate)

---

Site Scaffolding

Interactive Wizard — Guided setup with presets

Run without arguments for a guided experience:

bengal new site

The wizard prompts for site name, base URL, and presents preset options:

🎯 What kind of site are you building?
  📝 Blog            - Personal or professional blog
  📚 Documentation   - Technical docs or guides
  💼 Portfolio       - Showcase your work
  🏢 Business        - Company or product site
  📄 Resume          - Professional resume/CV site
  📦 Blank           - Empty site, no initial structure
  ⚙️  Custom         - Define your own structure

Each preset creates a complete site with appropriate sections, sample content, and configuration.

Direct Template Selection — Skip prompts with explicit options

Create sites non-interactively with --template:

bengal new site my-docs --template docs
bengal new site my-blog --template blog
bengal new site portfolio --template portfolio

Available templates:

Template	Description	Sections Created
default	Minimal starter	Home page only
blog	Personal/professional blog	blog, about
docs	Technical documentation	getting-started, guides, api
portfolio	Showcase work	about, projects, blog, contact
product	Product/company site	products, features, pricing, contact
landing	Single-page landing	Home, privacy, terms
resume	Professional CV	Single resume page
changelog	Release notes	Changelog with YAML data

Add Sections to Existing Sites — Expand without recreating

Add new content sections to an existing Bengal site:

# Add multiple sections
bengal project init --sections docs --sections tutorials

# Add sections with sample content
bengal project init --sections blog --with-content --pages-per-section 5

# Preview without creating files
bengal project init --sections api --dry-run

Section type inference:

Name Pattern	Inferred Type	Behavior
blog, posts, articles, news	blog	Date-sorted, post-style
docs, documentation, guides, tutorials	doc	Weight-sorted, doc-style
projects, portfolio	section	Standard section
about, contact	section	Standard section

Custom Skeleton Manifests — YAML-defined site structures

For complex or repeatable scaffolding, define structures in YAML manifests:

# Preview what would be created
bengal project skeleton apply my-structure.yaml --dry-run

# Apply the skeleton
bengal project skeleton apply my-structure.yaml

# Overwrite existing files
bengal project skeleton apply my-structure.yaml --force

Example manifest (docs-skeleton.yaml):

name: Documentation Site
description: Technical docs with navigation sections
version: "1.0"

cascade:
  type: doc  # Applied to all pages

structure:
  - path: _index.md
    props:
      title: Documentation
      description: Project documentation
      weight: 100
    content: |
      # Documentation
      Welcome! Start with our [Quick Start](getting-started/quickstart/).

  - path: getting-started/_index.md
    props:
      title: Getting Started
      weight: 10
    cascade:
      type: doc
    pages:
      - path: installation.md
        props:
          title: Installation
          weight: 20
        content: |
          # Installation
          ```bash
          pip install your-package
          ```

      - path: quickstart.md
        props:
          title: Quick Start
          weight: 30
        content: |
          # Quick Start
          Your first project in 5 minutes.

  - path: api/_index.md
    props:
      title: API Reference
      weight: 30
    content: |
      # API Reference
      Complete API documentation.

Component Model:

• path — File or directory path
• type — Component identity (blog, doc, landing)
• variant — Visual style variant
• props — Frontmatter data (title, weight, etc.)
• content — Markdown body content
• pages — Child components (makes this a section)
• cascade — Values inherited by all descendants

---

Features

Feature	Description	Docs
Directives	Tabs, admonitions, cards, dropdowns, code blocks	Content →
Autodoc	Generate API docs from Python, CLI, OpenAPI	Autodoc →
Remote Sources	Pull content from GitHub, Notion, REST APIs	Sources →
Theming	Dark mode, responsive, syntax highlighting, search	Theming →
Validation	Health checks, broken link detection, auto-fix	Building →
Performance	Parallel builds, incremental rebuilds, streaming	Large Sites →

📚 Full documentation: lbliii.github.io/bengal

---

Configuration

Single-file — Simple projects

# bengal.toml
[site]
title = "My Site"
baseurl = "https://example.com"

Directory-based — Multi-environment projects

config/
├── _default/           # Base configuration
│   ├── site.yaml
│   └── build.yaml
├── environments/       # Environment overrides
│   └── production.yaml
└── profiles/           # Build profiles
    └── dev.yaml

bengal build -e production    # Production environment
bengal build --profile dev    # Development profile

📖 Configuration guide: Configuration →

---

Project Structure

mysite/
├── content/          # Markdown pages
├── templates/        # Custom Jinja2 templates (optional)
├── assets/           # Static files (CSS, JS, images)
├── data/             # YAML/JSON data files
├── config/           # Configuration directory
└── public/           # Build output

---

Theming

Bengal ships with a modern, accessible default theme:

• Dark mode with system preference detection
• Responsive design with mobile navigation
• Syntax highlighting with copy buttons
• Table of contents with scroll spy
• Full-text search (Lunr.js)

Customize templates:

{# templates/page.html #}
{% extends "base.html" %}

{% block content %}
<article class="prose">
  <h1>{{ page.title }}</h1>
  {{ content | safe }}
</article>
{% endblock %}

---

Requirements

• Python 3.14+ (uses free-threading and PEP 784 compression)
• Linux, macOS, Windows

---

Philosophy

Bengal prioritizes correctness and clarity over backwards compatibility.

Each release represents the best solution we know how to deliver. When existing behavior no longer reflects the best design, it changes. Upgrades may require reading release notes and making adjustments.

• Fail loudly — Breaking changes produce clear errors
• User control — You choose when to upgrade; we choose what changes
• No hidden layers — No compatibility shims or deprecated code paths

If you need multi-year stability, pin your version.

---

Documentation

📚 lbliii.github.io/bengal

---

Development

git clone https://github.com/lbliii/bengal.git
cd bengal
uv sync --group dev
pytest

---

License

MIT