sourcegraph/syntect_server

syntect_server Docker镜像文档

镜像概述

syntect_server是一个基于Rust开发的HTTP服务器，专注于提供代码语法高亮功能。它通过HTTP API接收代码文本和语言信息，返回带有语法高亮标记的结果，适用于需要集成代码高亮能力的各类应用场景。

核心功能与特性

• 高性能：采用Rust语言开发，具备高效的代码处理能力和低资源占用特性
• 多语言支持：内置多种编程语言的语法定义，支持广泛的代码高亮需求
• HTTP接口：提供简洁的REST API，便于各类应用集成
• 轻量级部署：容器化设计，部署简单，适合快速集成到现有系统

使用场景

• 代码编辑器或IDE的实时语法高亮功能
• 技术文档系统中代码片段的高亮展示
• 代码审查工具的语法高亮支持
• 在线代码分享平台的代码美化处理

使用方法

基本部署

使用以下命令启动syntect_server容器：

bash
docker run -d -p 9238:9238 --name syntect_server docker.xuanyuan.run/sourcegraph/syntect_server

默认情况下，服务器监听9238端口，可通过-p参数映射到主机端口。

API使用示例

高亮代码片段

向/highlight端点发送POST请求，包含代码内容和语言信息：

bash
curl -X POST http://localhost:9238/highlight \
  -H "Content-Type: application/json" \
  -d '{"code": "fn main() {\n    println!(\"Hello, World!\");\n}", "language": "rust"}'

响应将返回带有语法高亮标记的HTML格式结果。

获取支持的语言列表

通过/languages端点获取服务器支持的所有编程语言：

bash
curl http://localhost:9238/languages

扩展配置

如需扩展支持的语言，可通过挂载自定义语法定义文件到容器内的语法目录（通常为/usr/share/syntect_server/syntaxes）实现。

更多信息

完整文档和源代码请访问项目GitHub仓库：https://github.com/sourcegraph/syntect_server