phase2/particle

一套用于在Pattern Lab中构建Drupal设计系统的工具。

安装: 969

依赖项: 0

建议者: 0

安全: 0

星标: 317

关注者: 38

分支: 118

开放问题: 79

语言:Twig

类型:drupal-custom-theme

v10.7.4 2020-08-27 18:39 UTC

README

GitHub (pre-)release Build Status Greenkeeper badge

Particle mascot: Astrogoat

Particle 是一套具有特定观点的工具和示例,用于

  1. 构建一个与应用无关的 设计系统
  2. 将该设计系统应用于本地服务的 Pattern Lab 以进行快速原型设计
  3. 将该设计系统应用于 Drupal 主题

有关使用此项目进行前端方法的深入文档,请参阅 Phase2 前端文档

先决条件

在OSX上安装所有依赖项的逐步说明可以在该Gist中找到。

提供

  • Drupal 主题、Grav 主题和Pattern Lab应用程序
  • 严格的 Atomic Design 组件结构
  • 为多个目标(Drupal 主题、Grav 主题、Pattern Lab)捆绑所有 CSS、javascript、字体和静态图像资源
  • Webpack Dev Server 用于本地托管并将资源热加载到Pattern Lab中
  • Twig 命名空间路径 自动添加到 Drupal 主题和 Pattern Lab 配置中。在任意的 twig 文件中,@atoms/thing.twig 对 Drupal 主题和 Pattern Lab 都有相同的意义。
  • 图标字体自动生成
  • AirBnB JavaScript Style Guide 进行自动 linting
  • 所有 Webpack 文件都可以完全配置
  • 用于设计系统组件创建的简单 Yeoman 生成器

快速入门

Particle 在开发模式下构建设计系统以进行本地托管,或在生产模式下进行优化资源生成。

快速入门 A

  1. 只需运行

    npm create @phase2/particle particle
  2. 然后 cd particle/ 并运行

    npm start

快速入门 B

  1. 下载最新版本
  2. 解压到任何位置(例如,此说明应位于 any/where/particle/README.md
  3. 在解压的文件夹中运行
npm install
npm run setup
npm start

只需等待 webpack 捆绑输出出现,然后访问 http://0.0.0.0:8080/app-pl/pl/(或 https://:8080/app-pl/pl/)并开始工作。

就这些。有关使用此项目进行前端方法的更多详细说明,请参阅 Phase2 前端文档

设计系统命名

设计系统源文件夹命名为 default ./source/default。在多设计设置中,可以按设计系统命名此文件夹,并在后缀中添加该设计系统名称。例如,apps/drupal-default/ 包含 default 源目录的实现。这些应根据您项目的需求进行更新。