mdbooker – 将你的 README.md 转换为文档网站

主要观点:介绍了将项目的README.md转换为美观文档网站makesure.dev的实用工具mdbooker,它与mdBook工具配合使用,通过AWK脚本实现,详细说明了其工作原理、使用步骤、技术细节及一些AWK技巧,还提到了替代方案Docsify并表示不喜欢其单页体验。
关键信息

  • mdbooker可将README.md转换为文档网站,基于mdBookAWK脚本实现。
  • 使用步骤包括运行mdbookermdBook及部署网站(未详述部署)。
  • AWK脚本通过两次遍历README.md来满足各项需求,如生成SUMMARY.md、拆分文件等。
  • 介绍了AWK中用于解析标题层次的match()函数及产生所需缩进的printf用法。
  • 给出了mdbooker工具的输出示例。
  • 替代方案Docsify是渲染README.md为单页网站的小JS库,但作者不喜欢其用户体验。
    重要细节
  • mdbookerawk脚本可在https://github.com/xonixx/mdbooker/blob/main/mdbooker.awk查看。
  • 运行mdbooker时需指定REPOBOOK参数。
  • 工具输出示例展示了对各种链接的修复和生成的多个.md文件。
  • Docsify是小型JS库,可将README.md渲染为单页网站。
阅读 13
0 条评论