yegor256/pages-action

镜像概述

本Docker镜像专注于将结构化事实库（factbase）内容转换并发布为HTML格式文档。通过自动化转换流程，可快速将事实库数据生成为标准化、可直接访问的静态HTML文件，支持本地查看或部署至Web服务器，简化事实库内容的可视化与共享过程。

核心功能与特性

核心功能

• 事实库至HTML转换：支持将结构化事实库数据（如JSON、CSV或特定格式的事实库文件）批量转换为HTML格式文档。
• 自动化发布流程：内置转换引擎，无需额外工具链，一键完成从事实库到HTML的生成过程。
• 静态文件输出：生成纯静态HTML文件，无运行时依赖，可直接通过浏览器打开或部署至任意静态文件服务器。

特性

• 轻量级设计：镜像体积小巧，依赖精简，运行高效。
• 灵活配置：支持通过参数自定义HTML输出样式（如主题、布局、导航结构等）。
• 目录映射：支持挂载本地事实库目录与输出目录，实现数据持久化与文件管理。

使用场景

• 知识库文档化：将技术知识库、产品手册等结构化事实库转换为网页文档，便于团队查阅与分享。
• 数据可视化呈现：将统计数据、调研结果等事实库内容以HTML格式可视化展示，提升数据可读性。
• 静态站点生成：作为轻量级静态站点生成工具，快速构建基于事实库的专题网页（如项目说明页、数据报告页）。

使用方法

基本使用流程

1. 准备事实库文件（需符合镜像支持的输入格式，如JSON、CSV等）；
2. 通过Docker命令挂载事实库目录与HTML输出目录；
3. 运行镜像，自动完成转换并生成HTML文件。

Docker Run命令示例

bash
docker run -d \
  -v /path/to/local/factbase:/input \  # 挂载本地事实库目录至容器内输入目录
  -v /path/to/output/html:/output \    # 挂载本地目录用于接收生成的HTML文件
  --name factbase-html-publisher \
  factbase-html-publisher:latest       # 镜像名称（请替换为实际镜像标签）

配置参数说明

自定义配置示例

如需指定深色主题并禁用导航栏，可通过环境变量调整：

bash
docker run -d \
  -v /path/to/local/factbase:/input \
  -v /path/to/output/html:/output \
  -e HTML_THEME=dark \
  -e INCLUDE_NAV=false \
  factbase-html-publisher:latest

注意事项

• 事实库文件需符合镜像支持的格式规范（具体格式要求请参考镜像完整文档或官方说明）；
• 输出目录需确保本地有读写权限，避免因权限问题导致文件生成失败；
• 生成的HTML文件可直接通过浏览器打开，或部署至Nginx、Apache等静态文件服务器提供Web访问。