Prism 项目技术文档

1. 安装指南

下载插件

首先，从 Prism 下载页面 下载最新版本的插件。请确保下载版本 1.0.3 或更高版本，以便使用 Sketch 45 插件自动更新功能。

安装插件

1. 解压缩下载的文件。
2. 将解压缩后的 Prism.sketchplugin 文件拖拽到 Sketch 的插件管理窗口中。

2. 项目使用说明

基本使用步骤

1. 安装插件：按照上述安装指南进行操作。
2. 添加颜色：在 Sketch 文档中，将所需颜色添加到 Document Colors。
3. 运行命令：使用快捷键 [ctrl cmd c] 生成颜色调色板。
4. 查看结果：颜色调色板将自动生成并显示在画布上。

修改颜色别名

要修改颜色别名，只需在 Name 层上更改文本内容。若想恢复默认颜色名称，删除该层的文本即可。

导出颜色为代码

1. 选择颜色（可选）：选择要导出的颜色。
2. 导出命令：
   • 导出选中颜色：使用快捷键 [ctrl cmd s]。
   • 导出所有颜色：使用快捷键 [ctrl cmd e]。
3. 选择格式：在弹出的窗口中选择导出格式（如 CSS, SASS 变量, Swift 等）。
4. 保存或复制：保存颜色代码文件或将代码复制到剪贴板。

3. 项目 API 使用文档

自定义模板文件

在 Prism 菜单中，选择 Show Template File... 选项，打开 Template.sketch 文件进行自定义。

修改调色板模板

1. 打开 Template.sketch 文件，该文件包含多个页面，每个页面都是一个单元格模板。
2. 添加或删除页面以管理模板。
3. 选择所需样式，保存对应页面。
4. 生成调色板查看更改效果。

编辑模板

1. 模板页面要求：

   • 只有一个名为 Prism Palette 的画板层。
   • 一个名为 Cell 的图层组，包含所有单元格元素。
   • Cell 组内必须有一个名为 Color 的图层，用于显示实际颜色。
   • Cell 组内必须有一个名为 Name 的文本图层，用于显示颜色名称。

2. 格式图层：

   • 可以添加多个文本图层用于不同格式显示，如 RGBA_CSS。

添加新格式

1. 在 src/formats 目录下创建新的格式化文件（Coffeescript）。
2. 创建 FormatterBase 的子类。
3. 覆盖 FormatterBase.coffee 中定义的方法：
   • 必须覆盖 id 和 name 方法。
   • 对于文本格式文件，覆盖 formatText 和 format 方法。
   • 对于二进制格式文件，覆盖 supportClipboard 和 exportAsFile 方法。
   • 对于导出多个文件的格式，覆盖 type 方法。

4. 项目安装方式

编译插件

1. 安装 Coffeescript v1：

   npm install --global coffeescript@1.12.7
   

2. 运行编译脚本： 在 Prism.sketchplugin/Content/Sketch 目录下执行：

   ./compile.sh
   

贡献代码

1. 提交 Pull Request：如有新功能需求或 bug 修复，请提交 PR。
2. 确保代码按照上述编译步骤进行编译。

未来计划

• 支持渐变色
• 更好的模板选择功能

致谢

• 创作者：Lalo & Adrxx
• 新格式结构：griffin-stewie
• 颜色分类器：特别感谢 Gauth 提供的颜色分类器和数据集。

希望这份文档能帮助您更好地使用 Prism 项目！