#markup #markdown-html #links #markdown #html #link #command-line

bin+lib mle

标记链接提取器(mle)从标记文件(Markdown 和 HTML)中提取链接

3 个不稳定版本

0.25.2 2024年6月2日
0.25.1 2024年6月2日
0.24.0 2023年12月5日

#293 in 文本处理

AGPL-3.0-or-later

130KB
3K SLoC

标记链接提取器

License: AGPL-3.0-or-later REUSE status Repo Package Releases Documentation Releases downloads Dependency Status Build Status

In cooperation with FabCity Hamburg In cooperation with Open Source Ecology Germany

从标记文件中提取链接。目前支持 htmlmarkdown 文件。标记链接提取器的主要目的是从一组文件中提取链接,然后使用单独的工具检查它们的有效性,例如Markdown 链接检查器。这两个工具可以集成到您的 CI 管道中,以警告您标记文档中的断链。

特性

  • markdownhtml 文件中查找链接
  • 支持 markdown 文件中的 HTML 链接和纯 URL
  • 友好的命令行界面
  • 简单的 CI 管道集成
  • 使用 async 非常快地执行

本地安装

安装和使用 mle 有不同的方法。

Cargo

使用 Rust 的包管理器 cargocrates.io 安装 mle

cargo install mle

下载二进制文件

要下载 mle 的编译版二进制文件,请访问 github releases 并下载为 x86_64-unknown-linux-gnux86_64-apple-darwin 编译的二进制文件。

CI 管道集成

GitHub Actions

使用 Marketplace 中的 GitHub-Action 在 GitHub 中使用 mle

- name: Markup Link Extractor (mle)
  uses: hoijui/[email protected]

使用 mle命令行参数 使用 with 参数

- name: Markup Link Extractor (mle)
  uses: hoijui/[email protected]
  with:
    args: ./README.md

二进制文件

要在 linux x86_64 环境 中运行的 CI 管道中集成 mle,您可以添加以下命令以下载工具

curl -L https://github.com/hoijui/mle/releases/download/v0.14.3/mle -o mle
chmod +x mle

例如,查看使用mle的CI管道的ntest仓库

Docker

使用来自Docker Hubmle Docker镜像,该镜像包含mle

用法

安装mle后,可以从命令行调用。以下调用将从当前文件夹及其所有子文件夹中找到的标记文件中提取所有链接

mle

另一个示例是在某个目录或文件上调用mle

mle ./docs

使用--help标志调用mle以显示所有可用的命令行参数

mle -h

请参阅参考以获取所有可用的命令行参数。

资助

该项目由欧洲区域发展基金(ERDF)在INTERFACER项目的框架内资助,从2022年7月(从mlc/project start))至2023年3月。

Logo of the EU ERDF program

依赖关系

~11–26MB
~421K SLoC