https://github.com/luyadev/luya-module-styleguide

Styleguide overview based on Elements-Component.
https://github.com/luyadev/luya-module-styleguide

Last synced: about 1 month ago
JSON representation

Styleguide overview based on Elements-Component.

• Host: GitHub
• URL: https://github.com/luyadev/luya-module-styleguide
• Owner: luyadev
• License: mit
• Created: 2015-08-31T06:47:02.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2021-10-12T06:46:25.000Z (about 3 years ago)
• Last Synced: 2024-11-13T04:08:30.798Z (about 1 month ago)
• Language: JavaScript
• Homepage: https://luya.io
• Size: 2.67 MB
• Stars: 0
• Watchers: 6
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        


  



# Element component styleguide

[![LUYA](https://img.shields.io/badge/Powered%20by-LUYA-brightgreen.svg)](https://luya.io)

[![Latest Stable Version](https://poser.pugx.org/luyadev/luya-module-styleguide/v/stable)](https://packagist.org/packages/luyadev/luya-module-styleguide)

[![Total Downloads](https://poser.pugx.org/luyadev/luya-module-styleguide/downloads)](https://packagist.org/packages/luyadev/luya-module-styleguide)

[![Slack Support](https://img.shields.io/badge/Slack-luyadev-yellowgreen.svg)](https://slack.luya.io/)

The basic idea behind the styleguide is to give you the ability to ensure an advanced development cycle for functions and design of enhanced elements.

![LUYA Styleguide](https://raw.githubusercontent.com/luyadev/luya-module-styleguide/master/styleguide.gif)

The styleguide module renders all the available {{luya\web\Element}} with example content which let you share all the elements with other designer to make and discuss changes based on elements instead on a finished web page. 

## Installation

For the installation of modules Composer is required.

```sh

composer require luyadev/luya-module-styleguide

```

### Configuration 

Configure the module in your project config, the password is protecting this page by default:

```php

'modules' => [

    // ...

    'styleguide' => [

        'class' => 'luya\styleguide\Module',

        'password' => 'styleguide-password',

        'assetFiles' => [

            'app\assets\ResourcesAsset',

        ],

    ]

]

```

After successful configuration of the styleguide module, you can access it through the url: `yourdomain.com/styleguide`