onsdigital/mathjax-api

mathjax-api 镜像文档

镜像概述和主要用途

mathjax-api镜像是一个Node.js HTTP API的Docker容器，用于在HTML内容中渲染MathJax公式。该服务基于MathJax-node实现，针对嵌入在HTML内容中的MathJax公式进行了优化，目前支持Tex格式到SVG格式的转换。

核心功能和特性

• 提供Node.js HTTP API服务，用于处理MathJax公式渲染请求
• 支持在HTML内容中嵌入的MathJax公式处理
• 实现Tex格式到SVG格式的公式转换
• 基于MathJax-node进行优化，适用于HTML内容中的数学公式渲染

使用场景和适用范围

该镜像适用于需要在应用中集成MathJax公式渲染功能的场景，特别是需要通过HTTP API服务将Tex格式公式转换为SVG的应用。例如：

• 在线教育平台的数学公式渲染
• 文档处理系统中的公式转换
• 需要动态生成数学公式SVG的Web应用

使用方法和配置说明

运行容器

API服务默认绑定到容器内的8080端口，通过以下命令运行容器并映射端口：

shell
docker run -d -p 8080:8080 --name mathjax-api-container mathjax-api

参数说明：

• -d：后台运行容器
• -p 8080:8080：将容器的8080端口映射到主机的8080端口
• --name mathjax-api-container：指定容器名称（可选）

验证服务运行状态

测试服务可用性

通过HTTP GET请求访问服务根路径，或在浏览器中导航至http://localhost:8080：

shell
curl http://localhost:8080

测试公式转换功能

通过HTTP POST请求提交Tex格式公式进行转换，示例：

shell
curl -X POST -H "Content-Type: text/plain" --data "input=$ Gamma(z) = int_0^infty t^{z-1} $" http://localhost:8080

该请求将返回转换后的SVG格式公式内容。

许可证信息

版权所有 © Crown Copyright（英国国家统计局）

本镜像基于MIT许可证发布，详情参见LICENCE。