hilite.me 技术文档

1. 安装指南

1.1 环境准备

在开始安装 hilite.me 之前，请确保您的系统已经安装了以下工具：

• nginx: 用于反向代理和静态文件服务。
• virtualenv: 用于创建Python虚拟环境。

1.2 安装步骤

1. 创建虚拟环境： 在项目根目录下运行以下命令来创建并激活虚拟环境：

   virtualenv env
   source env/bin/activate
   

2. 安装依赖： 在虚拟环境中，使用 pip 安装项目所需的依赖：

   pip install -r requirements.txt
   

3. 配置nginx： 编辑您的 nginx.conf 文件，添加以下内容：

   http {
       ...
       include /path/to/hilite.me/nginx-dev.conf;
   }
   

   确保在 nginx-dev.conf 中更新项目的路径，然后重启nginx服务。

4. 更新hosts文件： 在 /etc/hosts 文件中添加以下行：

   127.0.0.1  hilite.dev
   

5. 启动项目： 在项目根目录下运行以下命令来启动项目：

   make run
   

   然后访问 http://hilite.dev/，如果静态文件无法加载，请确保nginx对 hilite.me/static 目录具有 rx 权限。

2. 项目的使用说明

2.1 基本使用

hilite.me 是一个将代码片段转换为美观的HTML格式的工具，适用于嵌入博客文章或网站中。用户只需将代码粘贴到左侧面板，选择语言和颜色方案，然后点击“Highlight”按钮即可生成HTML代码。

2.2 支持的编程语言

hilite.me 支持多种编程语言，包括但不限于：

• Python
• Java
• C++
• JavaScript
• HTML
• CSS

2.3 颜色方案

用户可以选择多种颜色方案来美化代码，例如：

• autumn
• borland
• monokai
• vim

3. 项目API使用文档

3.1 API概述

hilite.me 提供了一个简单的API，允许开发者通过HTTP请求将代码片段转换为HTML格式。

3.2 API请求示例

以下是一个使用 curl 发送API请求的示例：

curl -X POST -d "code=print 'hello world'" -d "lang=python" -d "style=monokai" http://hilite.dev/api/highlight

3.3 API响应

API响应将返回生成的HTML代码，例如：

<div style="background: #ffffff; overflow:auto;width:auto;border:solid gray;border-width:.1em .1em .1em .8em;padding:.2em .6em;">
    <pre style="margin: 0; line-height: 125%">
        <span style="color: #008800; font-weight: bold">print</span> <span style="background-color: #fff0f0">'hello world'</span>
    </pre>
</div>

4. 项目安装方式

4.1 本地安装

按照上述“安装指南”中的步骤在本地安装并运行 hilite.me。

4.2 Docker安装

如果您更喜欢使用Docker，可以使用以下命令来构建并运行 hilite.me：

docker build -t hilite.me .
docker run -p 80:80 hilite.me

4.3 云服务部署

hilite.me 也可以部署到云服务（如AWS、Heroku等），具体步骤请参考相应云服务的文档。

通过本文档，您应该能够顺利安装、使用并深入了解 hilite.me 项目。如果您有任何问题，请参考项目的GitHub Wiki或联系开发者。