Markdown 单一来源,同时产出 HTML 与 PDF,避免两套内容不一致
Template_Library_Documentation — HTML 文档模板
作者 PLCnext
面向 IEC 61131 库的 Markdown 文档模板,经 Pandoc 与 wkhtmltopdf 生成 HTML/PDF,可导入 PLCnext Engineer 做上下文帮助。
看看你的网站会是什么样
浏览真实页面截图,比较内容排版与手机效果。点击下方缩略图切换,放大查看整页细节。
全部页面与视图 4
截图用于了解视觉与布局,交互效果请以实际项目为准。
值得关注的模板亮点
从已有项目资料中,快速了解它的特点。
HTML 可导入 PLCnext Engineer,为函数、功能块和 HMI 符号提供上下文帮助
PDF 面向 PLCnext Store 的可打印文档场景
附带 make.bat 批处理脚本和可自定义的样式表
文件名前缀控制章节顺序,Components 子目录按组件组织文档
模板详细介绍
这个仓库是 PLCnext 官方提供的库文档模板,用 Markdown 编写 IEC 61131 函数、功能块和 HMI 符号的说明,再通过批处理脚本一次生成 HTML 与 PDF 两种输出。模板本身不包含任何库代码,重点在于把内容组织、章节顺序和样式统一起来,让作者只关注写什么,而不是怎么排版。
生成物有明确去向:HTML 可以导入 PLCnext Engineer,为单个组件提供 SHIFT+F1 上下文帮助,也能作为整库说明挂到项目描述里;PDF 则适合上传到 PLCnext Store 作为可打印文档。仓库提供了带注释的 Markdown 模板文件、现成的 make.bat 和样式表,文件名前缀决定 PDF 章节顺序,组件文档集中在 Components 子目录下,便于按功能块逐个维护。
使用前需要自行安装 Pandoc 和 wkhtmltopdf,并可能要把它们加入 Windows 的 Path 环境变量;组件级 HTML 文件是重定向页,不能直接在浏览器里打开,只有在 PLCnext Engineer 中集成后才生效。另外,PLCnext Engineer 低于 2024.6 的版本对受读保护的功能块无法打开 HTML 帮助,集成步骤也要求 2023.3 及以上版本,这些版本边界需要按实际环境核对。
适合你的项目吗?
适用场景
- 为自研 IEC 61131 库编写随库发布的使用说明
- 需要把库文档同时交付为在线帮助和可打印 PDF
- 在 PLCnext Engineer 项目中为功能块配置 SHIFT+F1 上下文帮助
适合人群
- 使用 PLCnext Engineer 并发布库的开发者
- 习惯用 Markdown 写作、希望统一输出格式的文档维护者
- 能自行安装 Pandoc 与 wkhtmltopdf 的 Windows 用户
上手与定制指南
结合仓库当前版本的说明,按下面的资料检查内容、配置与运行要求。
- 1
需预先安装 Pandoc 和 wkhtmltopdf,必要时加入系统 Path
- 2
模板文件夹名不要包含空格,复制后按库名重命名
- 3
HTML 帮助集成要求 PLCnext Engineer ≥ 2023.3,受保护块的帮助需 ≥ 2024.6
- 4
组件级 HTML 为重定向文件,不能直接在浏览器中查看
- 5
仓库许可证状态标注为 review,使用前需确认授权条款
授权与来源资料
使用条件与限制
免费使用 · 保留许可声明MIT许可证允许免费使用、复制、修改、合并、发布、分发、再许可和销售,仅需保留版权与许可声明。
使用时需要遵守
- 保留原作者版权声明和 MIT 许可证声明。
- 在所有副本或实质性部分中包含版权声明和许可声明
额外费用与待核对事项
- README中提及的Pandoc和wkhtmltopdf为免费软件,但其自身许可未在提供文本中明确
查看原文依据
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software
许可证原文
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
许可证原文
https://github.com/PLCnext/Template_Library_Documentation/blob/main/LICENSEhttps://github.com/PLCnext/Template_Library_Documentation/blob/HEAD/README.mdPermission is hereby granted, free of char
许可证原文
DeepSeek 根据仓库许可证和 README 整理 ·2026-09-24。结果仅覆盖已读取资料,依赖、图片、字体及后续条款变更以各自原文为准。
项目核对记录与介绍依据
模板资料
- 来源平台
- GitHub
- 资料与维护参考分
- 资料一般 · 65 / 100
- 技术栈
- HTML
- 网站类型
- 文档
这个分数如何计算
本站按许可资料(最高30分)、演示链接(12分)、预览图(10分)、Star数(15分)、记录的维护时间(15分)、描述完整度(8分)、功能记录(5分)和分类资料(5分)计算。它不是代码、安全或性能测试,也不是 Google 评分;有链接不代表已实测可用。
这个项目需要核对什么
- 记录的仓库更新时间
- 2026-08-12
- 截图检查日期
- 2026-09-24
目前没有记录演示链接。请依据仓库说明在本地评估;仅凭截图无法确认交互行为。
目录记录的主要技术栈是 HTML。请通过依赖清单和锁文件核对实际版本与托管要求。这些说明基于收录资料,不代表代码审计或部署实测。
查看具体选型方法 →介绍的制作与核对状态
介绍由 AI 辅助整理目录与仓库资料。仓库作者不等于这篇介绍的审核者。
当前版本没有可核对的编辑审核记录;旧的应用时间不代表已完成事实审核。
这条历史介绍未保存固定版本的来源快照。请对照当前仓库,发现不一致可反馈。
反馈内容错误看看同类模板
对比同技术栈与用途的模板,找到更适合的视觉与内容结构。

documentation-html-template
A Sample Documentation Template for Themes, Templates and Plugins
HTML · 文档

iDocs
iDocs is one page documentation html template which helps you to create your offline and online documentation …
HTML · 文档

Simply-Docs
A simple, fast, free & easy to use static based plain HTML template. That allows you to make a beautiful perso…
HTML · 博客

DiscordFX
DiscordFX 是一个针对 DocFX 的文档模板,目标是让生成的文档站呈现类似 Discord 开发者文档的视觉风格。
HTML · 文档

SingulinkFX
SingulinkFX 是 Singulink 团队为自家 .NET 项目维护的 DocFX 模板,目标很明确:让生成的 API 文档看起来像微软官方 .NET 文档。
HTML · 文档

EU-AI-Act-Toolkit
EU-AI-Act-Toolkit 是一个面向中小企业的欧盟 AI 法案实用就绪工具箱,由法律专业人士维护,旨在将 AI 治理与合规准备变得可操作。
HTML · 文档
