使用 rustdoc 生成 markdown 文档?
Generate markdown docs with rustdoc?
有什么方法可以从 ///
条评论中在 doc/ 中生成单个降价文件吗?
多个降价文件(doc/main.md
、doc/foo.md
等)也不错。
我是 Rust 的新手,虽然生成的 HTML 文档很好,但我主要生活在命令行上,真的不想在我的终端和网络浏览器之间切换只是为了阅读文档。这打破了流程,让我离开了区域。此外,md 很容易转换为手册页,或转换为 TeX 用于打印或 PDF 文档。
(我习惯用 Ctrl-Z 或使用另一个终端选项卡暂停 vim,并且 运行 man
或 perldoc
或 pydoc
等等。像 lynx
或 links
这样的文本模式浏览器对我来说不是好的选择 - 导航很笨拙,如果我忘记使用我的 200 多个列终端 windows -width
选项,不支持javascript)
cargo-readme might work for you. You run cargo readme -i foo.rs > FOO.md
and it populates FOO.md with the contents of the doc comments from foo.rs. Found it via reddit.
有什么方法可以从 ///
条评论中在 doc/ 中生成单个降价文件吗?
多个降价文件(doc/main.md
、doc/foo.md
等)也不错。
我是 Rust 的新手,虽然生成的 HTML 文档很好,但我主要生活在命令行上,真的不想在我的终端和网络浏览器之间切换只是为了阅读文档。这打破了流程,让我离开了区域。此外,md 很容易转换为手册页,或转换为 TeX 用于打印或 PDF 文档。
(我习惯用 Ctrl-Z 或使用另一个终端选项卡暂停 vim,并且 运行 man
或 perldoc
或 pydoc
等等。像 lynx
或 links
这样的文本模式浏览器对我来说不是好的选择 - 导航很笨拙,如果我忘记使用我的 200 多个列终端 windows -width
选项,不支持javascript)
cargo-readme might work for you. You run cargo readme -i foo.rs > FOO.md
and it populates FOO.md with the contents of the doc comments from foo.rs. Found it via reddit.