{"id":17471696,"url":"https://github.com/bezoerb/shopware-styleguide","last_synced_at":"2025-04-10T04:42:27.661Z","repository":{"id":62493764,"uuid":"106054965","full_name":"bezoerb/shopware-styleguide","owner":"bezoerb","description":"Easily add a living styleguide for your shopware project","archived":false,"fork":false,"pushed_at":"2018-10-17T05:04:56.000Z","size":532,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-24T05:52:16.639Z","etag":null,"topics":["shopware-plugin","styleguide","work-in-progress"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bezoerb.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-10-06T22:21:09.000Z","updated_at":"2022-02-15T10:47:05.000Z","dependencies_parsed_at":"2022-11-02T11:31:12.034Z","dependency_job_id":null,"html_url":"https://github.com/bezoerb/shopware-styleguide","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bezoerb%2Fshopware-styleguide","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bezoerb%2Fshopware-styleguide/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bezoerb%2Fshopware-styleguide/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bezoerb%2Fshopware-styleguide/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bezoerb","download_url":"https://codeload.github.com/bezoerb/shopware-styleguide/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248161211,"owners_count":21057552,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["shopware-plugin","styleguide","work-in-progress"],"created_at":"2024-10-18T16:52:53.719Z","updated_at":"2025-04-10T04:42:27.643Z","avatar_url":"https://github.com/bezoerb.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Shopware Styleguide\n\n[![Software License][license-image]][license-url]\n\nEasily add a living styleguide for your [`shopware`](https://github.com/shopware/shopware) project\n\n## Install\n\n### Install using composer\n\nThis 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/)\n\n```\ncomposer require bezoerb/shopware-styleguide\n```\n\n### Alternative installation method\n\nIf 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`.\nAfter that you'll need to install the plugin dependencies via composer.\n\n```\ncd custom/plugins/Styleguide\ncomposer install\n```\n\nThis plugin can't be found at the shopware plugin registry yet.\n\n## Getting started\n\nAfter installing and activating this plugin you can reach the styleguide at the URL `http://my.shopoware.project.com/styleguide`\n\nThe plugin already tries to extract some basic information about your theme like colors, and fonts from the theme configuration.\nIf you your theme extends the shopware responsive theme the page should look something like this:\n\n![styleguide](./doc/styleguide.jpg)\n\n## File structure\n\n### Styleguide components\n\nThis plugin will pick up all files provided in `THEME/frontend/_includes/styleguide/**/*.tpl`\u003cbr\u003e\nIt also hijacks the `{$sMainCategories}` template assign to add a menu entry for each folder inside `THEME/frontend/\\_includes/styleguide/`\n\nEvery file inside these folders should represent one section in your styleguide.\n\nExample:\n\n```\n{extends file=\"frontend/styleguide/section.tpl\"}\n\n{block name=\"frontend_styleguide_section_title\"}\n  Fonts\n{/block}\n\n{block name=\"frontend_styleguide_section_description\"}\n  Lorem ipsum ...\n{/block}\n\n{block name=\"frontend_styleguide_section_content\"}\n  Main content...\n{/block}\n```\n\n![example](./doc/fonts.png)\n\n## Smarty helpers\n\nThis Plugin includes some helpers and templates to help you get started.\n\n### styleguide_html\n\n**Usage:** `{styleguide_html} ... {/styleguide_html}`\n\nPlace any markup in between and you'll get a preview.\u003cbr/\u003e You can add a HTML comment at the beginning to provide some documentation (markdown supported).\n\n![example](./doc/styleguide_section.gif)\n\n### styleguide_function\n\n**Usage:** `{styleguide_function name=\"...\" arguments=[...]}`\n\n**Params:**\n\n- **name**: Name of the smarty function\n- **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.\n\n### styleguide_include\n\n**Usage:** `{styleguide_include file=\"...\" arguments=[...]}`\n\n**Params:**\n\n- **file**: Filename\n- **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.\n\n## License\n\nThe MIT License (MIT). Please see [License File](LICENSE) for more information.\n\n© Ben Zörb\n\n[license-url]: LICENSE\n[license-image]: https://img.shields.io/badge/license-MIT-brightgreen.svg\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbezoerb%2Fshopware-styleguide","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbezoerb%2Fshopware-styleguide","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbezoerb%2Fshopware-styleguide/lists"}