# 关键的草图插件设置文档设置

关键的草图插件设置文档设置 提供了一种简单的方法来为你的Sketch插件添加设置文档，用户可以方便地为插件做一些自定义设置。

安装插件

要使用关键的草图插件设置文档设置插件，您需要按照以下步骤进行安装：

1. 下载并安装 Sketch 软件
2. 下载并安装 Sketch Runner 插件 （可选）
3. 下载并安装 关键的草图插件设置文档设置 插件文件
4. 在Sketch中打开 Preferences，然后转到 Plugins
5. 点击 "Manage Plugins"，选择 "Settings Documentation" 并打开它

添加设置文档

要为您的插件添加设置文档，请按照以下步骤执行：

1. 创建一个新的 Sketch 文件，并将其保存到您的插件文件夹中
2. 在Sketch中打开该文件并创建一个新的图层
3. 命名该图层为 Settings Documentation
4. 在 Settings Documentation 图层中，您可以添加您的插件设置的详情
5. 添加完毕，保存文件并关闭Sketch

在插件中使用设置文档

一旦您已经为您的插件添加了设置文档，您可以将它们添加到您的插件中。按照以下步骤操作：

1. 打开您的插件代码文件，例如 .js 或 .coffee
2. 导入关键的草图插件设置文档设置中的代码

    import { settingDocumentationForPluginIdentifier } from 'settings-documentation'
   

3. 获取您的插件标识符并将其作为参数传递给函数

    const settingDocumentation = settingDocumentationForPluginIdentifier('yourPluginIdentifier')
   

4. 获得可用的设置文档

    const settingDetails = settingDocumentation.getSettingDocuments()
   

5. 然后，在您的UI界面中利用该文档进行显示即可

注意事项

• 确认您已经将 Settings Documentation 图层从Sketch的图层列表中隐藏
• 如果向用户提供了一个自定义设置快捷方式，请添加相应的信息到您的设置文档中
• 同时，值得注意的是，该插件仅支持Sketch 53.2及以上版本

建议

• 当您添加设置文档时，尝试将它们写入一个简单的表格，以便用户更好地理解
• 在插件中，为设置文档添加注释以便您作为开发者更好地理解

参考连接

• 开发者文档
• 示例插件文档

返回Markdown格式代码片段

# 关键的草图插件设置文档设置

**关键的草图插件设置文档设置** 提供了一种简单的方法来为你的Sketch插件添加设置文档，用户可以方便地为插件做一些自定义设置。

## 安装插件

要使用关键的草图插件设置文档设置插件，您需要按照以下步骤进行安装：

1. 下载并安装 [Sketch](https://www.sketch.com/) 软件
2. 下载并安装 [Sketch Runner](https://sketchrunner.com/) 插件 （可选）
3. 下载并安装 [关键的草图插件设置文档设置](https://github.com/sureskumar/sketch-plugin-settings-documentation/releases) 插件文件
4. 在Sketch中打开 **Preferences**，然后转到 **Plugins** 
5. 点击 **"Manage Plugins"**，选择 **"Settings Documentation"** 并打开它

## 添加设置文档

要为您的插件添加设置文档，请按照以下步骤执行：

1. 创建一个新的 Sketch 文件，并将其保存到您的插件文件夹中
2. 在Sketch中打开该文件并创建一个新的图层
3. 命名该图层为 **Settings Documentation**
4. 在 **Settings Documentation** 图层中，您可以添加您的插件设置的详情
5. 添加完毕，保存文件并关闭Sketch

## 在插件中使用设置文档

一旦您已经为您的插件添加了设置文档，您可以将它们添加到您的插件中。按照以下步骤操作：

1. 打开您的插件代码文件，例如 **.js** 或 **.coffee**
2. 导入关键的草图插件设置文档设置中的代码

import { settingDocumentationForPluginIdentifier } from 'settings-documentation'
```

3. 获取您的插件标识符并将其作为参数传递给函数

    const settingDocumentation = settingDocumentationForPluginIdentifier('yourPluginIdentifier')
   

4. 获得可用的设置文档

    const settingDetails = settingDocumentation.getSettingDocuments()
   

5. 然后，在您的UI界面中利用该文档进行显示即可

注意事项

• 确认您已经将 Settings Documentation 图层从Sketch的图层列表中隐藏
• 如果向用户提供了一个自定义设置快捷方式，请添加相应的信息到您的设置文档中
• 同时，值得注意的是，该插件仅支持Sketch 53.2及以上版本

建议

• 当您添加设置文档时，尝试将它们写入一个简单的表格，以便用户更好地理解
• 在插件中，为设置文档添加注释以便您作为开发者更好地理解

参考连接

• 开发者文档
• 示例插件文档