README

Pattern Kit 是一个应用程序，让您可以通过与从模式架构构建的表单交互来预览模板库并操作其内容。它既是开发工具，也是面向公众的模式库。

要查看演示，请访问 Pattern Kit 演示。

安装

注意，按照以下说明操作，您不需要克隆此 Git 仓库。

在模式库根目录下创建 composer.json 文件并要求 pattern kit

"require": {
    "pattern-builder/pattern-kit": "@dev"
},
"repositories": [
  {
    "type": "vcs",
    "url": "https://github.com/PatternBuilder/pattern-kit"
  }
]

在模式库根目录下添加 index.php 文件

<?php

require_once __DIR__ . '/vendor/autoload.php';
require __DIR__ . '/vendor/pattern-builder/pattern-kit/src/app.php';

$app['http_cache']->run();

在模式库根目录下添加 .pk-config.yml 文件

• 创建指向您的数据、模式、模板、文档和风格指南文件的路径数组（相对于配置文件）
• 设置每种文件类型的文件扩展名
• 按您希望它们在导航中出现的顺序列出类别
• 使用 body_attr 添加您希望在 body 标签上打印的任何属性
• 创建用于 css、js 和页脚 js（如果需要，包括实时重载）的资产数组

title: Project Title

paths:  # relative to your pattern library root
  data:
    - path/to/sample/data
  schemas:
    - path/to/schemas
  templates:
    - path/to/templates
  docs:
    - path/to/schemas-docs
  sg:
    - path/to/stylelguide/docs
extensions:
  data: .docs.json
  schemas: .json
  templates: .twig
  docs: .docs.md
  sg: .sg.md
categories:
    - Pattern
    - Sub Pattern
    - Layout
    - Component
    - Atom
body_attr:
  - unresolved
  - class:
    - foo
    - bar
assets:
  css:
    - path/to/css
    - path/to/othercss
  js:
    - path/to/js
    - path/to/otherjs
  footer_js:
    - path/to/footer_js
    - path/to/otherfooter_js
    - //:1336/livereload.js

在您的终端中，

$ cd [pattern library root]
$ composer install

使用 Pattern Kit

将 MAMP 或本地 PHP 服务器指向您的 index.php 文件

php -S 0:9001 -t ./