QLColorCode 技术文档

本文档旨在帮助用户安装和使用 QLColorCode 项目，并详细介绍其功能与配置。QLColorCode 是一个 Quick Look 插件，用于在 Quick Look 预览中显示带有语法高亮的源代码。

1. 安装指南

安装步骤：

1. 下载 QLColorCode 插件。
2. 将插件拖放到 /Library/QuickLook 或 ~/Library/QuickLook 目录下。
3. 如果该目录不存在，则需要创建。

注意事项：

• 在 Xcode 3.2 或更高版本中，可能需要禁用 Xcode 内置的源代码 qlgenerator，才能看到 QLColorCode 的输出。

2. 项目使用说明

QLColorCode 使用 Highlight 库对源代码进行语法高亮显示。可以通过以下命令对插件进行配置：

• 设置文本编码（默认为 UTF-8）：

  defaults write org.n8gray.QLColorCode textEncoding UTF-16
  defaults write org.n8gray.QLColorCode webkitTextEncoding UTF-16
  

• 设置字体：

  defaults write org.n8gray.QLColorCode font Monaco
  

• 设置字体大小：

  defaults write org.n8gray.QLColorCode fontSizePoints 9
  

• 设置颜色样式（例如使用 ide-xcode 主题）：

  defaults write org.n8gray.QLColorCode hlTheme ide-xcode
  

• 设置 Highlight 额外命令行参数：

  defaults write org.n8gray.QLColorCode extraHLFlags '-l -W'
  

• 设置预览文件的最大大小（以字节为单位）：

  defaults write org.n8gray.QLColorCode maxFileSize 1000000
  

3. 项目API使用文档

QLColorCode 不直接提供 API，但它是基于 Highlight 库构建的，该库提供了一些有用的命令行参数。以下是一些常用的 Highlight 命令行参数：

• -F, --reformat=<style>：使用给定样式重新格式化输出。
• -J, --line-length=<num>：在换行之前的最长行长度。
• -j, --line-number-length=<num>：行号长度，包括左侧填充。
• -l, --linenumbers：在输出文件中打印行号。
• -t, --replace-tabs=<num>：将制表符替换为指定数量的空格。
• -V, --wrap-simple：在不缩进函数参数和语句的情况下包装长行。
• -W, --wrap：包装长行。
• -z, --zeroes：用零填充行号的前导空格。

4. 项目安装方式

若要从源代码构建 QLColorCode，需要以下步骤：

1. 下载 Highlight 库的源代码并解压缩。
2. 创建一个符号链接到 Highlight 库的源代码目录。

此外，通过修改 colorize.sh 脚本，可以使用此插件渲染任何可以转换为 HTML 的文件类型。祝您使用愉快！