Coloration 技术文档
1. 安装指南
环境要求
在本地运行 Coloration 命令行工具,需要安装现代版本 (> 2.0) 的 Ruby。请注意,在某些 Windows 安装环境中运行 Coloration 可能会遇到问题。(欢迎提交 Pull Request 改进!)
安装步骤
您可以通过以下两种方式使用 Coloration:在线或在本机上安装。
-
在线使用:访问 coloration.ku1ik.com 使用在线版本。
-
本地安装:如果希望在本机上安装 Coloration 以进行批量转换或其他操作,请执行以下命令:
gem install coloration安装后,您将获得
_tm2vim_、_tm2jedit_和_tm2katepart_三个命令行工具,用于执行转换。
2. 项目的使用说明
Coloration 是一个编辑器/IDE 配色方案转换器。目前,它允许您将喜爱的 Textmate 配色方案(XML plist 格式)转换为 Vim、JEdit 以及 KDevelop/Kate/KWrite 配色方案。它会尽力为给定的目标生成最准确的结果。
3. 项目API使用文档
Coloration 的 API 使用主要是通过命令行工具来实现。以下是一些基本的命令行用法:
-
转换 Textmate 配色方案到 Vim:
tm2vim input.plist output.vim -
转换 Textmate 配色方案到 JEdit:
tm2jedit input.plist output.jar -
转换 Textmate 配色方案到 KDevelop/Kate/KWrite:
tm2katepart input.plist output.xml
请确保将 input.plist 替换为您要转换的 Textmate 配色方案文件路径,output.vim、output.jar 或 output.xml 替换为您希望保存的输出文件路径。
4. 项目安装方式
项目的安装方式已在“安装指南”部分详细说明。简而言之,您可以通过以下命令在本地安装 Coloration:
gem install coloration
完成安装后,即可使用上述命令行工具进行配色方案转换。如果在转换过程中遇到任何问题,或者在尝试转换某个主题时 Coloration 失败或结果不尽如人意,请到 issue tracker 报告问题。