Sketch-ArtboardTricks 项目教程

Sketch-ArtboardTricks 项目教程

Sketch-ArtboardTricksA variety of artboard-related utilities for Sketch, primarily rearranging them into a grid, numbering them, etc.项目地址:https://gitcode.com/gh_mirrors/sk/Sketch-ArtboardTricks

1. 项目的目录结构及介绍

Sketch-ArtboardTricks 项目的目录结构如下：

Sketch-ArtboardTricks/
├── README.md
├── sketchplugin
│   ├── Contents
│   │   ├── Resources
│   │   │   └── icon.png
│   │   ├── Sketch
│   │   │   ├── manifest.json
│   │   │   └── script.js
│   │   └── document.json
│   └── ArtboardTricks.sketchplugin
└── LICENSE

目录结构介绍

• README.md: 项目说明文档，包含项目的基本信息和使用方法。
• sketchplugin/: 插件的主要文件夹。
  • Contents/: 插件的内容文件夹。
    • Resources/: 资源文件夹，包含插件的图标等资源。
      • icon.png: 插件的图标文件。
    • Sketch/: Sketch 插件的核心文件夹。
      • manifest.json: 插件的清单文件，包含插件的元数据。
      • script.js: 插件的主要脚本文件，包含插件的逻辑代码。
    • document.json: 插件的文档配置文件。
  • ArtboardTricks.sketchplugin: 插件的入口文件，用于启动插件。
• LICENSE: 项目的许可证文件。

2. 项目的启动文件介绍

项目的启动文件是 ArtboardTricks.sketchplugin，这是一个 macOS 包文件，双击该文件即可启动插件。该文件内部包含了插件的所有必要文件和配置，是插件的入口点。

3. 项目的配置文件介绍

项目的配置文件主要是 manifest.json 和 document.json。

manifest.json

manifest.json 文件包含了插件的元数据，如插件的名称、版本、作者等信息。以下是一个示例：

{
  "name": "Artboard Tricks",
  "description": "A Sketch plugin to help you manage your artboards.",
  "author": "Roman Nurik",
  "version": "1.0",
  "identifier": "com.romannurik.sketch.artboardtricks",
  "commands": [
    {
      "name": "Rearrange Artboards Into Grid",
      "identifier": "rearrange",
      "script": "script.js",
      "handler": "rearrangeArtboards"
    }
  ],
  "menu": {
    "title": "Artboard Tricks",
    "items": [
      "rearrange"
    ]
  }
}

document.json

document.json 文件包含了插件的文档配置信息，如插件的默认设置、用户偏好设置等。以下是一个示例：

{
  "defaultSettings": {
    "rowSpacing": 400,
    "columnSpacing": 100
  },
  "userPreferences": {
    "prefixArtboardNames": true
  }
}

通过这些配置文件，用户可以自定义插件的行为和外观，以满足不同的需求。

Sketch-ArtboardTricksA variety of artboard-related utilities for Sketch, primarily rearranging them into a grid, numbering them, etc.项目地址:https://gitcode.com/gh_mirrors/sk/Sketch-ArtboardTricks