Markdown阅读器

GitHub仓库 · 变更日志 · 贡献指南

一个实验性的Proof of Concept markdown阅读器，使用Ratatui渲染markdown文件。该crate的主要目的是测试tui-markdown crate。它尚未准备好用于任何实际应用。

安装

要安装markdown阅读器应用程序（mdr）

cargo install --locked markdown-reader

用法

mdr --help

A simple markdown reader that uses ratatui to render markdown files.

Usage: mdr [PATH]

Arguments:
  [PATH]  The path to the markdown file to read [default: README.md]

Options:
  -h, --help     Print help
  -V, --version  Print version

状态

初始实现 - 这仍然是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。