#broken-links #markdown #command-line-tool #file #header #detect #directory

bin+lib broken-md-links

用于检测Markdown文件中断链的命令行工具和库

9个版本 (稳定)

2.1.0 2023年9月21日
2.0.0 2023年9月21日
1.2.1 2022年6月17日
1.2.0 2021年3月17日
0.1.0 2020年7月30日

文本处理 中排名 570

Download history 14/week @ 2024-03-28 7/week @ 2024-04-04

每月下载量 132

Apache-2.0

24KB
385

损坏的Markdown链接

此仓库是一个用Rust编写的实用工具,确保Markdown文件中的所有链接都有效,通过确保目标文件存在。它还确保指向特定标题(如 [链接名称](文件.md#某些-标题))的链接在目标文件中存在。

命令行使用

检查单个文件

broken-md-links input.md

检查整个目录

broken-md-links dir/ -r

输出

有几种不同的详细程度

  • -v silent:不显示任何内容(如果没有断链,退出代码将为0)
  • -v errors:仅显示错误
  • -v warn:显示错误和警告(默认)
  • -v info:显示分析的文件列表
  • -v verbose:显示详细信息
  • -v trace:显示调试信息

库使用

use broken_md_links::check_broken_links;

fn main() {
  match check_broken_links(Path::new("file.md"), false, false, false, &mut HashMap::new()) {
    Ok(0)          => println!("No broken link :D"),
    Ok(errors @ _) => println!("There are {} broken links :(", errors),
    Err(err)       => println!("Something went wrong :( : {}", err)
  }
}

许可证

本项目遵循Apache-2.0许可证条款。

依赖

~5–17MB
~178K SLoC