Sublime Diagram Plugin 使用教程

Sublime Diagram Plugin 使用教程

sublime_diagram_plugin A Plug-In for Sublime Text 2 / 3 To Render Diagrams In Your Source Code 项目地址: https://gitcode.com/gh_mirrors/su/sublime_diagram_plugin

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

sublime_diagram_plugin/
├── Syntaxes/
│   ├── diagram
│   └── samples
├── .gitignore
├── no-sublime-package
├── Comments.tmPreferences
├── Default (Linux).sublime-keymap
├── Default (OSX).sublime-keymap
├── Default (Windows).sublime-keymap
├── Default.sublime-commands
├── Diagram.sublime-settings
├── LICENSE.txt
├── Main.sublime-menu
├── README.md
└── diagram_plugin.py

目录结构介绍

• Syntaxes/: 包含用于渲染图表的语法文件和示例文件。
  • diagram: 图表语法文件。
  • samples: 示例文件。
• .gitignore: Git 忽略文件配置。
• no-sublime-package: 用于指示 Sublime Text 不将插件打包。
• Comments.tmPreferences: 注释的语法配置文件。
• Default (Linux).sublime-keymap: Linux 系统下的快捷键配置文件。
• Default (OSX).sublime-keymap: macOS 系统下的快捷键配置文件。
• Default (Windows).sublime-keymap: Windows 系统下的快捷键配置文件。
• Default.sublime-commands: 默认命令配置文件。
• Diagram.sublime-settings: 图表插件的配置文件。
• LICENSE.txt: 项目许可证文件。
• Main.sublime-menu: 主菜单配置文件。
• README.md: 项目说明文件。
• diagram_plugin.py: 插件的主启动文件。

2. 项目的启动文件介绍

diagram_plugin.py

diagram_plugin.py 是 Sublime Diagram Plugin 的主启动文件。它包含了插件的核心逻辑，负责解析用户选择的文本并生成相应的图表。该文件定义了插件的主要功能和命令，并通过 Sublime Text 的 API 与编辑器进行交互。

3. 项目的配置文件介绍

Diagram.sublime-settings

Diagram.sublime-settings 是 Sublime Diagram Plugin 的配置文件。用户可以通过编辑此文件来定制插件的行为，例如：

• Viewer: 指定用于查看生成的图表的默认查看器。
• Sanity Checks: 控制是否在启动时进行检查。
• Character Set: 设置图表文件的默认字符集。

用户可以通过在 Sublime Text 的 Packages/User 目录下创建一个同名的配置文件来覆盖默认设置。

示例配置

{
    "viewer": "MacOS X Preview",
    "sanity_checks": false,
    "charset": "UTF-8"
}

通过以上配置，用户可以自定义图表的查看器、禁用启动时的检查，并设置图表文件的字符集。

sublime_diagram_plugin A Plug-In for Sublime Text 2 / 3 To Render Diagrams In Your Source Code 项目地址: https://gitcode.com/gh_mirrors/su/sublime_diagram_plugin