Marketch 项目使用教程

Marketch 项目使用教程

marketchMarketch is a Sketch 3 plug-in for automatically generating html page that can measure and get CSS styles on it.项目地址:https://gitcode.com/gh_mirrors/ma/marketch

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

Marketch 是一个 Sketch 3 插件，用于自动生成一个 HTML 页面，该页面可以测量并获取 CSS 样式。以下是项目的目录结构及其介绍：

marketch/
├── marketch.sketchplugin/
│   └── Contents/
│       ├── Sketch/
│       │   ├── manifest.json
│       │   ├── script.js
│       │   └── ...
│       └── Resources/
│           └── ...
├── .gitignore
├── .gitattributes
├── CHANGELOG.md
├── LICENSE
├── README.md
├── contribution.md
├── issue-template.md
├── package.json
└── ...

• marketch.sketchplugin/: 插件的主目录。
  • Contents/: 包含插件的核心内容。
    • Sketch/: 包含插件的脚本和配置文件。
      • manifest.json: 插件的配置文件，定义了插件的基本信息和入口点。
      • script.js: 插件的主要脚本文件，包含了插件的核心逻辑。
    • Resources/: 包含插件所需的资源文件。
• .gitignore: Git 忽略文件列表。
• .gitattributes: Git 属性配置文件。
• CHANGELOG.md: 项目更新日志。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• contribution.md: 贡献指南。
• issue-template.md: 问题报告模板。
• package.json: 项目的 npm 配置文件。

2. 项目的启动文件介绍

Marketch 插件的启动文件是 marketch.sketchplugin/Contents/Sketch/script.js。这个文件包含了插件的主要逻辑，当用户在 Sketch 中使用插件时，会执行这个文件中的代码。

3. 项目的配置文件介绍

Marketch 插件的配置文件是 marketch.sketchplugin/Contents/Sketch/manifest.json。这个文件定义了插件的基本信息和入口点，包括插件的名称、版本、作者、描述等信息。以下是一个示例配置文件的内容：

{
  "name": "Marketch",
  "description": "Marketch is a Sketch 3 plug-in for automatically generating html page that can measure and get CSS styles on it.",
  "author": "tudou527",
  "version": "1.0.24",
  "identifier": "com.tudou527.marketch",
  "commands": [
    {
      "name": "Generate HTML",
      "identifier": "generateHTML",
      "script": "script.js",
      "handler": "onRun"
    }
  ],
  "menu": {
    "title": "Marketch",
    "items": [
      "generateHTML"
    ]
  }
}

• name: 插件的名称。
• description: 插件的描述。
• author: 插件的作者。
• version: 插件的版本。
• identifier: 插件的唯一标识符。
• commands: 定义了插件的命令，包括命令的名称、标识符、脚本文件和处理函数。
• menu: 定义了插件在 Sketch 菜单中的显示方式。

通过以上介绍，您可以更好地理解和使用 Marketch 插件。希望这个教程对您有所帮助！

marketchMarketch is a Sketch 3 plug-in for automatically generating html page that can measure and get CSS styles on it.项目地址:https://gitcode.com/gh_mirrors/ma/marketch