Lorem Ipsum Plugin for Sketch 使用教程
1. 项目的目录结构及介绍
Lorem Ipsum Plugin for Sketch 是一个用于生成占位文本的 Sketch 插件。以下是该项目的目录结构及其介绍:
Lorem-Ipsum-Plugin-for-Sketch/
├── README.md
├── LoremIpsum.sketchplugin
│ ├── Contents
│ │ ├── Resources
│ │ │ └── icon.png
│ │ └── Sketch
│ │ ├── manifest.json
│ │ └── my-command.js
│ └── template.sketch
└── LICENSE
- README.md: 项目说明文件,包含项目的基本信息和使用说明。
- LoremIpsum.sketchplugin: 插件的主目录,包含插件的所有内容。
- Contents: 插件内容目录。
- Resources: 资源文件夹,包含插件的图标文件
icon.png
。 - Sketch: Sketch 相关文件夹,包含插件的配置文件
manifest.json
和主要脚本文件my-command.js
。
- Resources: 资源文件夹,包含插件的图标文件
- template.sketch: 模板文件,用于生成占位文本。
- Contents: 插件内容目录。
- LICENSE: 项目的许可协议文件。
2. 项目的启动文件介绍
项目的启动文件是 my-command.js
,位于 LoremIpsum.sketchplugin/Contents/Sketch/
目录下。该文件是插件的主要逻辑脚本,负责生成占位文本并插入到 Sketch 文档中。
@import "my-command.js"
3. 项目的配置文件介绍
项目的配置文件是 manifest.json
,位于 LoremIpsum.sketchplugin/Contents/Sketch/
目录下。该文件定义了插件的基本信息和命令配置。
{
"name": "Lorem Ipsum",
"description": "Generate Lorem Ipsum text in Sketch.",
"author": "Brandon Beecroft",
"homepage": "https://github.com/brandonbeecroft/Lorem-Ipsum-Plugin-for-Sketch",
"version": "1.0",
"identifier": "com.brandonbeecroft.lorem-ipsum",
"commands": [
{
"name": "Generate Lorem Ipsum",
"identifier": "generateLoremIpsum",
"script": "my-command.js",
"handler": "onRun"
}
],
"menu": {
"title": "Lorem Ipsum",
"items": [
"generateLoremIpsum"
]
}
}
- name: 插件的名称。
- description: 插件的描述。
- author: 插件的作者。
- homepage: 插件的主页链接。
- version: 插件的版本号。
- identifier: 插件的唯一标识符。
- commands: 插件的命令列表,包含命令的名称、标识符、脚本文件和处理函数。
- menu: 插件的菜单配置,定义了菜单的标题和包含的命令项。
以上是 Lorem Ipsum Plugin for Sketch 项目的详细介绍和使用教程。希望对您有所帮助!