README

此扩展包将 kss-php 库简单地集成到Symfony2中。KSS是CSS文档化和生成风格指南的方法。有关KSS的更多信息，请访问 http://warpspire.com/kss/。

安装

通过composer安装此扩展包是最简单的方式。在您的Symfony2项目文件夹中，键入以下命令

$ composer require scan/kss-bundle

这将安装扩展包及其所有依赖项。

接下来，您需要通过将其添加到您的Kernel中启用扩展包

<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...

        new Scan\Bundle\KssBundle\ScanKssBundle(),
    );
}

最后，如果您想尝试扩展包中提供的示例，您需要将以下内容添加到您的symfony2路由中。

# app/config/routing_dev.yml
scan_kss:
    resource: @ScanKssBundle/Controller/
    type:     annotation
    prefix:   /_kssExample

基本用法

要输出动态生成的风格指南，您需要在控制器中创建一个 \Scan\Kss\Parser，并将其传递包含您的样式的目录。

<?php

namespace Scan\Bundle\KssBundle\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
use Scan\Kss\Parser;

class ExampleController extends Controller
{
    /**
     * @Route("/styleguide")
     * @Template
     */
    public function styleguideAction()
    {
        $kss = new Parser($this->getRequest()->server->get('DOCUMENT_ROOT') . '/bundles/scankss/css');
        return array(
            'kss' => $kss,
        );
    }
}

然后在您的视图中，当您想要输出风格指南的部分时，使用以下twig包含

{% include 'ScanKssBundle:Blocks:block.html.twig' with
    {
        'section' : kss.getSection('Buttons - Stars')
    }
%}

最后，您需要在布局或视图中包含一个小的JavaScript文件，以帮助渲染伪类如 :hover、:disabled 等。这可以通过以下行在布局或视图中完成

{% javascripts '@ScanKssBundle/Resources/public/js/*' %}
    <script src="{{ asset_url }}"></script>
{% endjavascripts %}

如果您愿意，您可以选择为块创建自己的样式或使用包含的样式。要使用包含的样式，请将以下内容添加到您的布局或视图中

{% stylesheets 'bundles/scankss/css/*' %}
    <link rel="stylesheet" href="{{ asset_url }}" />
{% endstylesheets %}

有关完整示例，请参阅包含的示例控制器、视图和样式表。

scan / kss-bundle

维护者

详细信息

README

安装

基本用法