README

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
• pattern-lab/unified-asset-installer: 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的标准版到名为your-project-name的目录，该目录位于install/location/下。在设置过程中，您将被要求安装适当的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

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

安装StarterKit

要将一个近乎空白的StarterKit作为项目的起点进行安装，请输入

php core/console --starterkit --init

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

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