Tui-markdown

一个将 markdown 内容转换为 Ratatui Text 值的实验性概念库。有关使用此库的示例应用程序，请参阅 Markdown-reader。

GitHub 仓库 · API 文档 · [示例] · 变更日志 · 贡献

安装

cargo add tui-markdown

用法

let input = "# Heading\n\n**bold**"; // this can come from whereever
let text = tui_markdown::from_str(input);
text.render(area, &mut buf);

状态

初始实现 - 这仍然是 WIP（请参阅 lib.rs 中的 todo!()）

• 标题
• 标题属性/类/锚点
• 普通段落
• 引用块
• 嵌套引用块
• 粗体（强调）
• 斜体（强调）
• 删除线
• 有序列表
• 无序列表
• 代码块
• HTML
• 脚注
• 表格
• 换行处理
• 规则
• 任务列表
• 链接
• 图片
• 元数据块

许可证

版权（c）2024 Josh McKinney

本项目受以下许可证之一保护：

• Apache 许可证 2.0（LICENSE-APACHE 或 http://www.apache.org/licenses/LICENSE-2.0）
• MIT 许可证（LICENSE-MIT 或 http://opensource.org/licenses/MIT）

由您选择。

贡献

除非您明确说明，否则任何提交给本项目以供包含在内的贡献，根据 Apache-2.0 许可证的定义，均应双重许可如上所述，不附加任何额外条款或条件。

请参阅 CONTRIBUTING.md。