Lib.rs

如果您想要插入一个代码块，您可以使用 set_lines，它将行样式应用于所有传递的行。

例如

let text_template = TextTemplate::from(r#"
    ## Example of a code block
        ${some-function}
    "#);
let mut expander = text_template.expander();
expander.set_lines("some-function", r#"
    fun test(a rational) {
    irate(a)
    }
    "#);
skin.print_expander(expander);

要获取

您可以在文档和示例中找到更多文本模板函数（运行 cargo run --example text-template）。

您可能还对 OwningTemplateExpander 感兴趣：这是一个拥有值的替代展开器，这在您在子模板中迭代构建它们时可能很有用。

提问

在 CLI 应用程序中，经常需要要求用户选择一个答案。 Question API 和 ask! 宏涵盖了大多数基本需求。

以下是一个带有默认选项（通过按 enter 获取）和返回值的提问示例

let choice = ask!(skin, "Do you want to drink something ?", ('n') {
    ('w', "I'd like some **w**ater, please.") => {
        mad_print_inline!(skin, "*Wait a minute, please, I'll fetch some.*\n");
        Some("water")
    }
    ('b', "Could I get a **b**eer glass ?") => {
        mad_print_inline!(skin, "We have no glass, so here's a *bottle*.\n");
        Some("beer")
    }
    ('n', "*No*, thank you.") => {
        None
    }
});
dbg!(choice);

皮肤文件

MadSkin 可以使用 serde 反序列化。

例如，Hjson 中的此类皮肤可以是

bold: "#fb0 bold"
italic: dim italic
strikeout: crossedout red
bullet: ○ yellow bold
paragraph: gray(20)
code_block: gray(2) gray(15) center
headers: [
    yellow bold center
    yellow underlined
    yellow
]
quote: > red
horizontal-rule: "~ #00cafe"
table: "#540 center"
scrollbar: "#fb0 gray(11) |"

执行 cargo run --example skin-file 以获取示例和说明。

入门建议

• 首先阅读示例（在 /examples 中）：它们涵盖了几乎整个 API，包括模板、如何使用备用屏幕或滚动页面等。许多示例打印了大量的相关文档。
• “render-input-markdown”示例允许你在文本区域中输入一些Markdown，并在下面查看渲染效果。
• 请注意，某些颜色在所有终端上可能无法显示。您应用程序的默认颜色集不应包括任意的RGB颜色。
• Termimad的事件/事件源部分目前针对少量应用程序进行了优化。如果您使用它或想使用它，请告诉我，以便考虑您的需求！
• 如果您想格式化一些CLI应用程序的输出，例如一些表格，请查看dysk，这是最简单可能的用法之一。
• 如果缺少功能或您不知道如何使用某个部分，请在欧洲西部时间来我的聊天中ping我。

使用termimad的开源应用程序

• broot是一个文件管理器，它使用termimad为其帮助屏幕、状态信息和事件管理提供支持。

• lfs是一个显示文件系统的Linux实用程序。Termimad模板用于在表格中显示数据。

• SafeCloset是一个秘密保险库。它的TUI大量使用Termimad，特别是输入。

• Rhit是一个nginx日志分析器。Termimad模板用于在表格中显示数据。

• bacon是一个后台Rust编译器。它使用Termimad进行显示和事件管理。

• lapin是一个终端游戏。它使用Termimad进行显示和事件管理。

• backdown是一个文件去重器。它使用Termimad在屏幕上打印并提问。

• Humility是一个嵌入式系统的调试器。它使用Termimad通过humility doc子命令打印Markdown文档。

如果您是使用Termimad的另一个应用程序的作者，请告诉我。

Crossterm兼容性

Crossterm是一个0.x库，这意味着它的API尚未冻结。因此，有时它会发生变化，因此基于Crossterm的库不能总是使用其最新版本。

Termimad重新导出Crossterm 0.27.x，因此您不必自己声明导入。您可以像这样使用crossterm：termimad::crossterm。