主要观点:介绍了将项目的README.md
转换为美观文档网站makesure.dev
的实用工具mdbooker
,它与mdBook
工具配合使用,通过AWK
脚本实现,详细说明了其工作原理、使用步骤、技术细节及一些AWK
技巧,还提到了替代方案Docsify
并表示不喜欢其单页体验。
关键信息:
mdbooker
可将README.md
转换为文档网站,基于mdBook
和AWK
脚本实现。- 使用步骤包括运行
mdbooker
、mdBook
及部署网站(未详述部署)。 AWK
脚本通过两次遍历README.md
来满足各项需求,如生成SUMMARY.md
、拆分文件等。- 介绍了
AWK
中用于解析标题层次的match()
函数及产生所需缩进的printf
用法。 - 给出了
mdbooker
工具的输出示例。 - 替代方案
Docsify
是渲染README.md
为单页网站的小JS
库,但作者不喜欢其用户体验。
重要细节: mdbooker
的awk
脚本可在https://github.com/xonixx/mdbooker/blob/main/mdbooker.awk
查看。- 运行
mdbooker
时需指定REPO
和BOOK
参数。 - 工具输出示例展示了对各种链接的修复和生成的多个
.md
文件。 Docsify
是小型JS
库,可将README.md
渲染为单页网站。
**粗体** _斜体_ [链接](http://example.com) `代码` - 列表 > 引用
。你还可以使用@
来通知其他用户。