首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >是否使用rustdoc生成markdown文档?

是否使用rustdoc生成markdown文档?
EN

Stack Overflow用户
提问于 2019-12-03 12:48:20
回答 1查看 353关注 0票数 9

有没有办法在doc/中从///注释生成单个标记文件?

多个标记文件(doc/main.mddoc/foo.md等)也很好。

我是rust的新手,虽然生成的HTML文档很好,但我主要生活在命令行上,真的不想仅仅为了阅读文档而在终端和web浏览器之间切换。这打破了流程,把我带出了禁区。此外,md很容易转换为手册页,或者用于打印或PDF文档的TeX。

(我习惯于使用Ctrl-Z或其他终端选项卡暂停vim,并运行manperldocpydoc等。文本模式浏览器,如lynxlinks对我来说不是很好的选择-导航很笨拙,如果我忘记使用200+选项,在我的-width列终端窗口上的输出很难看,而且都不支持javascript)

EN

回答 1

Stack Overflow用户

回答已采纳

发布于 2021-08-22 17:08:24

cargo-readme可能会为您工作。您运行cargo readme -i foo.rs > FOO.md,它将使用来自foo.rs的文档注释的内容填充FOO.md。找到了via reddit

票数 2
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/59150327

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档