lokalise/docprint

docprint镜像概述

docprint是一个将API Blueprint文档转换为静态HTML文件的工具，基于原Docprint项目并修复了部分bug，提供清晰的UI展示和丰富的功能支持。

核心功能

• 单独渲染资源属性，支持嵌套属性
• 允许添加自定义头部HTML和CSS文件
• 支持六种语言的代码片段展示
• 提供锚点导航（Waypoint）支持
• 完整的Markdown语法支持
• 简洁美观的用户界面

使用场景

• API文档的静态化展示，方便团队内部或外部查阅
• 生成多语言版本的API文档（如curl、PHP等）
• 自定义API文档的样式和头部信息，满足品牌化需求

配置说明

Docker运行示例

将本地API Blueprint文件转换为HTML：

bash
docker run -v $(pwd)/input:/input -v $(pwd)/output:/output lokalise/docprint docprint -p /input/polls.apib -d /output/docs -h /input/header.html -c /input/custom.css

作为Node.js库使用

安装依赖：

bash
npm install --save docprint

代码示例：

javascript
const docprint = require('docprint');
docprint({
  filepath: './input/polls.apib',
  destination: './output/docs',
  header: './input/header.html',
  css: './input/custom.css'
});

文件包含语法

使用:[name](path)格式包含其他文件：

:[Overview](blueprint/overview.md)
:[Search](blueprint/search.apib)

语言选择

文档中的语言切换会替换URL中的语言关键词，需确保静态文件挂载方式支持不同语言路径的访问（如/docs/curl/index.html切换为/docs/php/index.html）。

选项参数说明