dadada - 由 trio

手工制作 Rust 内联代码文档渲染器（基于 Rui Vieira 的 dada；受 docco 启发）

这里截图 / 动作视频

安装

您可以使用 cargo install dadada 轻松安装它。

用法

dadada 将被安装为命令行工具，您可以运行它。只需指定您想要渲染的文件，它就会这样做。如果您不提供目标输出文件（--output / -o），则结果将打印到 stdout。

完整的 CLI 参数列表是

Benjamin Kampmann <ben@gnunicorn.org>, Rui Vieira <ruidevieira@googlemail.com>
Artisanal Rust inlined code documentation renderer

USAGE:
    dadada [FLAGS] [OPTIONS] <FILE>...

FLAGS:
    -h, --help       Prints help information
        --no-css     Do not add CSS to output
        --no-js      Do not add Javascript to output
    -V, --version    Prints version information

OPTIONS:
    -o, --output <FILE>     target file to render to, stdout if not given
    -t, --title <String>    The HTML title to render

ARGS:
    <FILE>...    rust source files

例如，要将您的 crate 下的所有 Rust 文件渲染到 target/dadada-output.html，可以这样使用：dadada --title "All my Code Example" -o target/dadada-output.html src/*.rs。

待办事项 朝 1.0 发展

需要帮助!

• 改进 Readme
• 使 HTML 移动友好/响应式
• 从 HTML 中删除远程包含
• 添加 --title-CLI 参数以添加标题
• 额外的 --meta、--header 和 --footer 参数，以便于自定义
• travis.yml 示例 以在推送时构建
• build.rs 脚本示例 以自动构建 crate 的所有示例
• 集成和回归测试套件