Daux.io:一款用 PHP 写成的文档生成工具

5次阅读
没有评论
Daux.io 免费下载
获取下载链
微信关注「软件教程管家」公众号,回复 daux.io
官方渠道:GitHub 仓库

Daux.io 是一款用 PHP 写成的文档生成工具:你不用在后台一篇篇录入文章,只要把 Markdown 文件按文件夹放好,它就能自动生成带导航、带首页、能在手机上正常浏览的文档网站。写开发文档、产品手册、项目指南时,这种文件夹即目录的写法,比在编辑器里拖拽排版要省事得多,也更容易放进版本控制。

文档生成是什么:Daux.io 的工作方式

它的约定非常简单:建立一个 docs 文件夹,里面的子文件夹就是导航里的分组,Markdown 文件就是一篇篇正文。运行生成命令后,文件夹结构会被转成完整的 HTML 文档站,首页自动生成,链接地址对搜索引擎友好,代码块自带语法高亮。内容改了只需要改 Markdown 文件,重新生成一次,网站就跟着更新,不用再去后台逐页调整排版。

它生成的是静态页面,发布时把生成结果放到 Apache 或 Nginx 上就能访问。预览时可以用 serve 命令先在本地看效果,确认无误再生成正式版本。

基本信息与版本选择

项目名称 Daux.io
实现语言 PHP
内容格式 Markdown,遵循 CommonMark,支持表格
组织方式 docs 文件夹加目录结构,文件夹即导航分组
输出形态 响应式静态 HTML,可部署到 Apache 或 Nginx
内置主题 四种内置主题,也支持自写主题
常用命令 generate 生成静态站,serve 本地预览
协作方式 适合与 Git 或 SVN 一起管理文档目录
源码获取 前往 GitHub 仓库

源稿没有给出可以核实的固定版本号,因此这里不写版本号。版本选择按部署方式分两档:已有 PHP 与 Composer 环境的团队,直接用 PHP 安装路线;不想折腾本地 PHP 版本的团队,走 Docker 路线更稳。无论走哪条线,动手前都要先对照完整说明确认自己环境的 PHP 版本是否在支持范围内,不要凭经验假定最新版一定能用。

文档生成安装步骤

  1. 准备好 PHP 与 Composer 环境,或者准备好 Docker,二选一即可。
  2. 按说明安装 Daux.io,确认 daux 命令可以在终端正常调用。
  3. 新建项目目录并在其中建立 docs 文件夹,把现有 Markdown 文档按分组放进对应的子文件夹。
  4. 先用 serve 命令在本地预览,检查导航分组、首页、正文排版、代码高亮是否都正常。
  5. 确认无误后用 generate 命令生成静态结果,把生成目录部署到 Apache 或 Nginx。
  6. 在目标服务器上再验证一遍链接、主题样式、移动端布局,全部通过才算发布完成。

必改设置

  • 目录结构要先定好再写内容:文件夹名就是导航分组名,分组一开始定错,后面改文件夹等于改整站导航,越早定越省事。
  • 主题要在第一版就选定:四种内置主题先挑一个最贴近项目气质的用起来,自写主题留到文档量稳定后再做,不要边写边换主题。
  • 首页内容要单独写一页:首页是读者进站第一眼看到的页面,放项目简介、快速入口和版本说明,不要让它自动生成的内容空着。
  • 统计配置按需开启:项目支持配置常见的网站统计工具,需要数据就配好,不需要就保持关闭,不要为了统计而多接用不上的服务。
  • 生成结果要进版本控制:Markdown 源文件、目录结构、主题文件一起提交,生成出来的静态页面可以单独部署,但源文件丢了就没法再改。

注意事项

  • 它没有在线编辑:想改文档必须改 Markdown 文件再重新生成,习惯了后台点一点就发布的人,刚开始会觉得多了一步。
  • 它没有内置权限与审核流:谁能看、谁能改、改完谁审核,这些流程要靠仓库权限和团队约定来补,不能指望工具自带。
  • 全文搜索能力要另外评估:公开说明里没有把搜索讲透,如果文档量大、读者必须靠搜索找内容,上线前一定要实测搜索体验够不够用。
  • 复杂内容模型可能要额外设计:纯文件夹加 Markdown 适合层级清晰的文档,内容关系特别复杂时,主题或流程上要多做一层设计。
  • 环境兼容性要先核实:PHP、Composer、Docker 各自的版本要求在摘要里没有一次给全,升级前先在测试环境跑通生成流程。

适用人群与对比

适合三类人:一是维护开发者文档、接口说明、项目指南的个人开发者;二是文档要随代码一起走版本控制的开源项目维护者;三是想用文件夹管理产品手册、技术团队内部资料的团队。反过来,如果团队需要多人在线协作编辑、细粒度权限、内容审核流,它就不是合适的人选,硬套只会越用越别扭。

方案 适合场景 短板
Daux.io Markdown 文件夹生成静态文档站 无在线编辑与权限审核
在线文档平台 多人实时协作写文档 内容不在自己仓库里,迁移成本高
手写静态页面 页面极少且长期不动 文档一多,导航与排版维护量暴涨

取舍建议

取舍看团队的工作习惯:如果文档已经习惯用 Markdown 写、习惯用 Git 管理,那就选它,文件夹即目录的约定会让维护成本一直很低,生成静态站也让部署变得简单;如果团队成员不写 Markdown、指望打开网页就能改内容,那就不要选它,省下的部署时间会在培训和催稿上加倍花掉。先拿一份真实文档做试点:放进 docs 文件夹、生成、部署、手机上看一遍,这四步都顺,再把整套文档迁过来。

关注公众号,回复 daux.io 获取下载链接

推广Daux.io 免费下载

关注「软件教程管家」

回复软件名即取即下:网盘下载链接 + 提取码,一步直达,不用再跳转。

版权与使用提示

本站资源仅供个人学习交流,请勿用于商业用途。软件与资料版权归原作者所有;如有侵权,请通过公众号「软件教程管家」联系我们,我们将在 24 小时内下架处理。查看免责声明 ›

上次编辑至今:12小时 · 内容还比较新鲜

公告

契机库网站正式上线!

了解更多
正文完
 0
评论(没有评论)