tealr_doc_gen

这个工具旨在与 tealr 一起使用，用于生成使用 tealr 创建的 lua/teal api 的在线文档

渲染示例

https://lenscas.github.io/tealsql/

特性

• 完整 Markdown 支持
• 代码示例中的代码高亮
• 支持多种主题
• 标记为 teal_lua 的片段被编译为 lua 并嵌入两种版本。
• 在编译 teal_lua 片段时，任何错误都会被记录。

如何获取 json

生成文档所需的 json 文件可以通过以下方式轻松获取

use tealr::{
    TypeWalker,
};

fn main() {
    let types = TypeWalker::new()
        .process_type::<crate::TypeYouWantToDocument>()
        .process_type<crate::OtherTypeYouWantToDocument>();
    
    let json = serde_json::to_string_pretty(&types).unwrap();
    println!("{}",json); //save to a file
    
}

安装

安装，只需运行

cargo install tealr_doc_gen

Cargo 将完成剩余的工作。

安装后，通过运行

tealr_doc_gen --json path/to/json/file --name yourApiName

参数

必需参数

• --json /path/to/json/generated/by/tealr
• --name nameOfTheLibrary

可选参数

• --build_folder 存储生成的 HTML 页面的文件夹（默认为 ./pages）
• --root 如果 / 不会是服务器的根目录，则设置