PHPackages                             bezoerb/shopware-styleguide - 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. [Utility & Helpers](/categories/utility)
4. /
5. bezoerb/shopware-styleguide

ActiveShopware-plugin[Utility & Helpers](/categories/utility)

bezoerb/shopware-styleguide
===========================

The styleguide plugin allows you to easily add a living styleguide for your shopware installation

v1.1.2(7y ago)556MITPHP

Since Jul 9Pushed 7y ago1 watchersCompare

[ Source](https://github.com/bezoerb/shopware-styleguide)[ Packagist](https://packagist.org/packages/bezoerb/shopware-styleguide)[ RSS](/packages/bezoerb-shopware-styleguide/feed)WikiDiscussions master Synced 2w ago

READMEChangelog (5)Dependencies (3)Versions (9)Used By (0)

Shopware Styleguide
===================

[](#shopware-styleguide)

[![Software License](https://camo.githubusercontent.com/074b89bca64d3edc93a1db6c7e3b1636b874540ba91d66367c0e5e354c56d0ea/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e737667)](LICENSE)

Easily add a living styleguide for your [`shopware`](https://github.com/shopware/shopware) project

Install
-------

[](#install)

### Install using composer

[](#install-using-composer)

This method requires shopware to be installed by composer as well. See this guide for details: [developers-guide/shopware-composer](https://developers.shopware.com/developers-guide/shopware-composer/)

```
composer require bezoerb/shopware-styleguide

```

### Alternative installation method

[](#alternative-installation-method)

If you don't want to use composer you'll have to download the latest [release](https://github.com/bezoerb/shopware-styleguide/releases) and copy the files to `custom/plugins/Styleguide`. After that you'll need to install the plugin dependencies via composer.

```
cd custom/plugins/Styleguide
composer install

```

This plugin can't be found at the shopware plugin registry yet.

Getting started
---------------

[](#getting-started)

After installing and activating this plugin you can reach the styleguide at the URL `http://my.shopoware.project.com/styleguide`

The plugin already tries to extract some basic information about your theme like colors, and fonts from the theme configuration. If you your theme extends the shopware responsive theme the page should look something like this:

[![styleguide](./doc/styleguide.jpg)](./doc/styleguide.jpg)

File structure
--------------

[](#file-structure)

### Styleguide components

[](#styleguide-components)

This plugin will pick up all files provided in `THEME/frontend/_includes/styleguide/**/*.tpl`
It also hijacks the `{$sMainCategories}` template assign to add a menu entry for each folder inside `THEME/frontend/\_includes/styleguide/`

Every file inside these folders should represent one section in your styleguide.

Example:

```
{extends file="frontend/styleguide/section.tpl"}

{block name="frontend_styleguide_section_title"}
  Fonts
{/block}

{block name="frontend_styleguide_section_description"}
  Lorem ipsum ...
{/block}

{block name="frontend_styleguide_section_content"}
  Main content...
{/block}

```

[![example](./doc/fonts.png)](./doc/fonts.png)

Smarty helpers
--------------

[](#smarty-helpers)

This Plugin includes some helpers and templates to help you get started.

### styleguide\_html

[](#styleguide_html)

**Usage:** `{styleguide_html} ... {/styleguide_html}`

Place any markup in between and you'll get a preview.
 You can add a HTML comment at the beginning to provide some documentation (markdown supported).

[![example](./doc/styleguide_section.gif)](./doc/styleguide_section.gif)

### styleguide\_function

[](#styleguide_function)

**Usage:** `{styleguide_function name="..." arguments=[...]}`

**Params:**

- **name**: Name of the smarty function
- **arguments**: Assoc array or array of assoc arrays with function arguments. Use an array of argument arrays to show different variations of your function result.

### styleguide\_include

[](#styleguide_include)

**Usage:** `{styleguide_include file="..." arguments=[...]}`

**Params:**

- **file**: Filename
- **arguments**: Assoc array or array of assoc arrays with variables passed to the included file. Use an array of argument arrays to show different variations of your component.

License
-------

[](#license)

The MIT License (MIT). Please see [License File](LICENSE) for more information.

© Ben Zörb

###  Health Score

30

—

LowBetter than 62% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity13

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity68

Established project with proven stability

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~14 days

Total

8

Last Release

2813d ago

Major Versions

v0.1.0 → v1.0.02018-07-18

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/1697800?v=4)[Ben Zörb](/maintainers/bezoerb)[@bezoerb](https://github.com/bezoerb)

---

Top Contributors

[![bezoerb](https://avatars.githubusercontent.com/u/1697800?v=4)](https://github.com/bezoerb "bezoerb (30 commits)")

---

Tags

shopware-pluginstyleguidework-in-progress

### Embed Badge

![Health badge](/badges/bezoerb-shopware-styleguide/health.svg)

```
[![Health](https://phpackages.com/badges/bezoerb-shopware-styleguide/health.svg)](https://phpackages.com/packages/bezoerb-shopware-styleguide)
```

###  Alternatives

[afragen/github-updater

A plugin to automatically update GitHub, Bitbucket, GitLab, or Gitea hosted plugins, themes, and language packs.

3.3k20.4k](/packages/afragen-github-updater)[afragen/git-updater

A plugin to automatically update GitHub, Bitbucket, GitLab, or Gitea hosted plugins, themes, and language packs.

3.3k1.7k](/packages/afragen-git-updater)[wp-hooks/generator

Generates a JSON representation of the WordPress actions and filters in your code

87179.9k5](/packages/wp-hooks-generator)[benmanu/silverstripe-styleguide

Generates a styleguide for a SilverStripe theme

108.1k1](/packages/benmanu-silverstripe-styleguide)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)