Ein Styleguide in brandbox ist technisch gesehen ein durch Composer installierbares Paket. Es verfügt über ein eigenes vendor prefix innerhalb der composer.json und muss einer festen Struktur von Ordnern und Dateien folgen.

• custom-styleguide
  • asset
  • component
  • element
  • javascript
  • partials
  • scss
  • templates
  • composer.json
  • custom-styleguide.config.json

composer.json

{
    "name": "brandbox-styleguide/custom-styleguide",
    // ...
    "autoload": {
        "classmap": [
            "component/",
            "element/"
        ]
    }
}

Zum einen muss auf den Namen des Composer-Paketes geachtet werden. Als vendor prefix muss brandbox-styleguide genutzt werden. Zudem muss der Name des Pakets auf -styleguide enden. Als Autoloader muss die classmap genutzt werden, da die Datenklassen der Komponenten eines Styleguide nicht den Vorgaben von PSR folgen.

custom-styleguide.config.json

{
	"label": "custom",
	"order": 123,
	"priority": 456,
	"depends": ["framework-styleguide", "other-styleguide"],
	"preview": "@preview-framework-styleguide"
}