README

Pattern Lab 标准版Twig

标准版Twig为开发人员和设计师提供了一个干净、稳定的基线，以便从该基线开发基于Twig的模式库。

组件包

标准版Twig附带以下组件

• pattern-lab/core: GitHub, Packagist
• pattern-lab/patternengine-twig: 文档, GitHub, Packagist
• pattern-lab/styleguidekit-assets-default: GitHub, Packagist
• pattern-lab/styleguidekit-twig-default: GitHub, Packagist

安装

下载和安装标准版Twig有两种方法

• 下载预构建的项目
• 使用Composer创建项目

下载预构建的项目

开始使用标准版Twig最快的方法是从发行页面下载预构建版本。预构建项目默认安装了Base StarterKit for Twig。

请注意：Pattern Lab 使用 Composer 来管理项目依赖。要升级标准版Twig或安装插件，您需要安装Composer。我们建议您全局安装。

使用Composer创建项目

Pattern Lab 使用 Composer 来管理项目依赖。

1. 安装 Composer

请按照 Composer 网站上的说明安装 Composer。我们建议您全局安装它。

2. 安装 Twig 标准版

使用 Composer 的 create-project 命令 将 Twig 标准版安装到您选择的目录。在终端输入

cd install/location/
composer create-project pattern-lab/edition-twig-standard your-project-name && cd $_

这将把 Twig 标准版安装到 install/location/ 目录下名为 your-project-name 的目录中。在设置过程中，您将被要求安装一个合适的 StarterKit。在过程完成后，您将自动进入项目目录。

更新 Pattern Lab

要更新 Pattern Lab，请参考每个组件的 GitHub 仓库。组件列表位于 README 的顶部。

有用的命令

以下是一些您可以在命令行中使用，用于处理 Pattern Lab 的有用命令。

列出所有可用命令

要列出所有可用命令，请输入

php core/console --help

要列出特定命令的选项，请输入

php core/console --help --[command]

生成 Pattern Lab

要生成 Pattern Lab 的前端，请输入

php core/console --generate

监视更改并重新生成 Pattern Lab

要监视更改并重新生成 Pattern Lab 的前端，请输入

php core/console --watch

启动服务器以查看 Pattern Lab

您可以使用 PHP 内置的 Web 服务器在浏览器中审查您的 Pattern Lab 项目。在另一个窗口中输入

php core/console --server

然后在浏览器中打开 http://localhost:8080。

安装 StarterKit

要将接近空白的 StarterKit 作为项目的起点安装，请输入

php core/console --starterkit --init

要从 GitHub 安装特定的 StarterKit，请输入

php core/console --starterkit --install <starterkit-vendor/starterkit-name>