在现代 Web 开发中,前端经常需要处理大量的 Markdown 文件。当我们需要从这些文件中提取链接时,可能需要耗费很多时间。不过,幸运的是,有一个简单易用的 npm 包可以将这个过程彻底自动化:get-md-links。
get-md-links 是一个命令行工具,可用于提取 Markdown 文件中的所有链接。它支持本地文件系统和远程 URL,因此非常适合用于爬取网站链接、处理博客文章等场景。
安装
可以通过 npm 安装 get-md-links。
npm install -g get-md-links
使用方法
查看命令行帮助
要使用 get-md-links,首先需要查看命令行帮助。
get-md-links --help
输出如下:
Usage: get-md-links [options] [path] Options: -v --version output the version number -r, --remote get remote link(from internet) -e, --exclude <xs> exclude filename or path [split by ","] (default: "node_modules") -h, --help output usage information
解释如下:
-v
或--version
:查看版本号。-r
或--remote
:获取远程链接。不添加这个选项,则只会提取本地链接。-e
或--exclude
:需要排除的文件名或路径,多个用逗号分隔,默认排除 node_modules 文件夹。将node_modules
排除出去可以防止搜索到大量无用链接。-h
或--help
:查看帮助。
示例
提取本地文件中的链接
假设我们有一个 Markdown 文件 example.md
,其中包含两个链接:
# Example 这是一个 [示例](./example.html)。 这是另一个 [链接](../another-example.md)。
要提取这些链接,可以输入以下命令:
get-md-links example.md
输出如下:
./example.html ../another-example.md
提取远程链接
如果 Markdown 文件中包含远程链接,也可以使用 get-md-links 一并提取。只需要添加 -r
选项即可。
假设我们有一个 Markdown 文件 example.md
,其中包含一个远程链接:
# Example 这是一个 [示例](https://example.com)。
要提取这个链接,可以输入以下命令:
get-md-links -r example.md
输出如下:
https://example.com
排除指定路径或文件名
有时候我们可能需要排除一些路径或文件名,以防止搜索到无用链接。可以使用 -e
或 --exclude
选项来指定需要排除的路径或文件名。
假设我们有以下两个 Markdown 文件:
test/ ├── demo.md └── example.md
我们只需要在提取 example.md
中的链接,而不需要在 demo.md
中提取链接,可以使用以下命令:
get-md-links -e demo.md test/example.md
输出如下:
./example.html ../another-example.md
总结
使用 get-md-links,提取 Markdown 文件中的链接变得非常简单。它支持本地链接和远程链接,还支持排除指定的路径或文件名,非常适用于处理大量 Markdown 文件的场景。当然,需要注意的是,在爬取网站链接时请尊重他人的版权和隐私,以免触犯法律和道德规范。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6005601581e8991b448de2c9