Skip to content

architecture.md

Latest commit

 

History

History
81 lines (60 loc) · 3.55 KB

architecture.md

File metadata and controls

81 lines (60 loc) · 3.55 KB
Raw

Architecture

YiiPress is a static website engine with two user-facing modes: build a production-ready static site, and serve a live local preview of that same generated output.

The same pipeline is used by both commands:

  • yiipress build writes the final static files.
  • yiipress serve rebuilds the same output directory and serves it with live reload for local preview.
flowchart LR
    content["content/<br>Markdown, YAML, assets"] --> parse["Parse"]
    parse --> index["Index"]
    index --> render["Render"]
    render --> write["Write"]
    templates["templates/themes"] --> render
    plugins["processors/plugins"] --> render
    write --> output["output/<br>static site"]
    output --> preview["serve preview"]
Loading

Content Model

User content lives under content/:

  • config.yaml — site-wide settings.
  • navigation.yaml — one or more navigation menus.
  • <collection>/_collection.yaml — collection settings.
  • <collection>/*.md — default-language entries in a collection.
  • <collection>/<locale>/*.md — localized collection entries, for example blog/ru/post.md.
  • authors/*.md — author profiles.
  • assets/ and <collection>/assets/ — copied static files.

YiiPress turns those files into immutable model objects: site config, navigation, collections, entries, authors, taxonomies, and output pages. Entry settings are resolved in this order:

flowchart LR
    entry["Entry front matter"] --> collection["Collection config"]
    collection --> site["Site config"]
    site --> defaults["Engine defaults"]
Loading

The first configured value wins. For example, an entry permalink overrides a collection permalink, which overrides the site-wide pattern.

Build Pipeline

  1. Parse — read config, collection files, author files, and entry front matter.
  2. Index — resolve permalinks, apply draft/future filters, sort collections, group taxonomies, build archives, and connect authors.
  3. Render — convert Markdown to HTML, apply processors, render PHP templates, and produce page objects.
  4. Write — write index.html, feeds, sitemap, redirects, search index, copied assets, and other static files.
flowchart TD
    parse["Parse files"] --> index["Build site index"]
    index --> entries["Entry and page HTML"]
    index --> listings["Listings, archives, taxonomies, authors"]
    index --> feeds["Feeds and sitemap"]
    entries --> write["Write output"]
    listings --> write
    feeds --> write
    assets["Copy assets"] --> write
Loading

Runtime Modes

Build

yiipress build is the production path. It generates static files and exits. The generated output can be deployed to any static host and does not require PHP in production.

Serve

yiipress serve is the preview path. It serves files from output/, injects live reload into HTML responses, and triggers normal builds when content or templates change. Because preview uses the same generated files as production, build and serve output stay aligned.

Extension Points

  • Templates control page HTML. See Templates.
  • Content processors transform Markdown and rendered HTML. See Plugins.
  • Lifecycle hooks expose PSR-14 build and render events for plugin behavior that is not a single content transformation. See Plugins.
  • Importers convert external content sources into Markdown files. See Importing content.

Engine-level implementation details, dependency flow, source layout, caching strategy, and performance notes are in Engine.