OmniMarkupPreviewer 插件使用教程

OmniMarkupPreviewer 插件使用教程

OmniMarkupPreviewerSublime Text 2&3 plugin to live preview markup files, supported (not limited to) markup formats are markdown, reStructuredText, WikiCreole and textile.项目地址:https://gitcode.com/gh_mirrors/om/OmniMarkupPreviewer

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

OmniMarkupPreviewer 是一个用于 Sublime Text 2 和 3 的插件，用于在浏览器中实时预览标记语言文件。以下是该项目的目录结构及其介绍：

OmniMarkupPreviewer/
├── LICENSE
├── Main sublime-menu
├── OmniMarkupPreviewer.py
├── OmniMarkupPreviewer sublime-commands
├── OmniMarkupPreviewer sublime-settings
├── README.md
├── default_settings.json
├── messages.json
├── package.json
└── ...

• LICENSE: 项目的许可证文件。
• Main sublime-menu: 主菜单配置文件。
• OmniMarkupPreviewer.py: 插件的主启动文件。
• OmniMarkupPreviewer sublime-commands: 插件的命令配置文件。
• OmniMarkupPreviewer sublime-settings: 插件的设置文件。
• README.md: 项目的说明文档。
• default_settings.json: 默认设置文件。
• messages.json: 消息配置文件。
• package.json: 包的元数据文件。

2. 项目的启动文件介绍

OmniMarkupPreviewer.py 是插件的主启动文件，负责初始化和启动插件的主要功能。以下是该文件的主要功能介绍：

• 初始化插件: 加载必要的配置和资源。
• 注册命令: 注册插件提供的命令，如预览、导出 HTML 等。
• 处理事件: 处理 Sublime Text 的事件，如文件保存时自动刷新预览。

3. 项目的配置文件介绍

OmniMarkupPreviewer sublime-settings 是插件的配置文件，用户可以通过修改该文件来定制插件的行为。以下是该文件的主要配置项介绍：

• server_host: 设置服务器的主机地址，默认为 127.0.0.1。
• server_port: 设置服务器的端口号，默认为 51004。
• extensions: 启用或禁用特定的扩展功能，如表格、代码高亮等。
• mathjax_enabled: 是否启用 MathJax 支持，用于渲染数学公式。

通过修改这些配置项，用户可以根据自己的需求定制插件的行为，例如在多端设备上查看预览或在浏览器中启用 MathJax 支持。

---

以上是 OmniMarkupPreviewer 插件的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地使用和配置该插件。

OmniMarkupPreviewerSublime Text 2&3 plugin to live preview markup files, supported (not limited to) markup formats are markdown, reStructuredText, WikiCreole and textile.项目地址:https://gitcode.com/gh_mirrors/om/OmniMarkupPreviewer