PHPackages                             vinou/site-builder - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Templating & Views](/categories/templating)
4. /
5. vinou/site-builder

ActiveLibrary[Templating & Views](/categories/templating)

vinou/site-builder
==================

PHP library to generate template based webpages with dynamic content from the Vinou Plattform

4.1.6(1mo ago)21.0kGPL-2.0+PHPPHP >=8.2

Since Mar 29Pushed 1mo ago3 watchersCompare

[ Source](https://github.com/vinou-platform/sitebuilder)[ Packagist](https://packagist.org/packages/vinou/site-builder)[ Docs](http://doc.vinou.de)[ RSS](/packages/vinou-site-builder/feed)WikiDiscussions master Synced 3w ago

READMEChangelogDependencies (22)Versions (106)Used By (0)

Vinou Site-Builder
==================

[](#vinou-site-builder)

The Vinou Site-Builder is a PHP library that combines PHP routing configured in YAML files with Twig template rendering. It provides a data processing pipeline to call registered processors and pipe results directly into Twig templates.

### Table of contents

[](#table-of-contents)

- [Typical project structure](#typical-project-structure)
- [Installation](#installation)
- [Route configuration](#route-configuration)
    1. [General route parameters](#1-general-route-parameters)
    2. [Sitemap configuration](#2-sitemap-configuration-for-a-route)
    3. [dataProcessing](#3-use-dataprocessing)
    4. [Extend a parent route](#4-extend-a-parent-route)
    5. [Global content (additionalContent)](#5-global-content-additionalcontent)
    6. [Registered processors](#6-registered-processors)
    7. [Register your own processor](#7-register-your-own-processor)
- [Settings](#settings)
- [Template override hierarchy](#template-override-hierarchy)
- [Twig filters](#twig-filters)
- [Classlist](#classlist)
- [Provider](#provider)

---

Typical project structure
-------------------------

[](#typical-project-structure)

FileDescription`composer.json`Composer configuration`config/settings.yml`SiteBuilder and ApiConnector settings`config/routes.yml`Project-specific routes`config/mail.yml`SMTP credentials and form definitions`public/index.php`Application entry point`public/.htaccess`Routes all requests to index.php`public/Resources/Layouts/`Twig layout overrides`public/Resources/Partials/`Twig partial overrides`public/Resources/Templates/`Page templates`public/Resources/Sass/`SCSS source filesThe complete example project is available in `Examples/Project/`.

---

Installation
------------

[](#installation)

```
composer require vinou/site-builder
cp -R vendor/vinou/site-builder/Examples/Project/config ./
cp -R vendor/vinou/site-builder/Examples/Project/web ./
```

**Required after installation:**

- Set Vinou `authid` and `token` in `config/settings.yml` — find them in [Vinou Office](https://app.vinou.de)
- Set SMTP credentials in `config/mail.yml`

**Typical optional setup:**

- Add project routes to `config/routes.yml`
- Configure Vinou constants in `public/index.php`

**Minimal `public/index.php`:**

```