markdown-image-localizer 使用教程

markdown-image-localizer 使用教程

markdown-image-localizer🖼Fastly list or localize the images in markdowns.项目地址:https://gitcode.com/gh_mirrors/ma/markdown-image-localizer

1. 项目介绍

markdown-image-localizer 是一个用于快速列出或本地化 Markdown 文件中图片的开源工具。它可以帮助用户轻松地将 Markdown 文件中的图片链接下载到本地，并替换为本地路径，从而方便离线查看和管理。

2. 项目快速启动

安装

首先，确保你已经安装了 Node.js 和 npm。然后，通过以下命令全局安装 markdown-image-localizer：

npm i -g img-localizer

使用

安装完成后，切换到包含 Markdown 文件的目录，并执行以下命令：

imgloc

该命令将会自动下载 Markdown 文件中的图片，并将其保存到当前目录下的 assets 文件夹中。

示例代码

以下是一个简单的示例代码，展示了如何使用 markdown-image-localizer 下载并替换 Markdown 文件中的图片链接：

const path = require('path');
const imgLoc = require('img-localizer');

// 解析出一个目录中所有文件对应的所有图片链接
const dir = path.resolve(__dirname, './markdown文件夹');
const dirImgObjArr = await imgLoc.extractDir(dir);

let current = 0;
const total = dirImgObjArr.length;

for (let dirImgObj of dirImgObjArr) {
  current++;
  console.log(`(${current}/${total}) 开始下载markdown图片 ${dirImgObj.path}`);

  // 下载单个文件对应的所有图片链接
  const res = await imgLoc.downDir(dirImgObj, {
    onSuccess: function(index, filename) {
      console.log(` ${index}/${dirImgObj.image.length} 图片下载成功 ${filename}`);
    }
  });

  // 替换单个markdown文件中的图片链接
  imgLoc.replaceDir(res);
  console.log(`(${current}/${total}) markdown图片下载成功\n`);
}

3. 应用案例和最佳实践

应用案例

• 离线文档管理：在需要离线查看 Markdown 文档时，使用 markdown-image-localizer 将所有图片下载到本地，确保文档的完整性。
• 版本控制：在版本控制系统中，使用该工具将图片本地化，避免因外部图片链接失效而导致文档不可用。

最佳实践

• 定期更新：定期使用该工具更新 Markdown 文档中的图片，确保所有图片链接都是最新的。
• 备份图片：在下载图片后，建议将 assets 文件夹备份，以防图片丢失。

4. 典型生态项目

• Markdown 编辑器：如 Typora、VSCode 等，这些编辑器可以与 markdown-image-localizer 结合使用，提升文档管理的效率。
• 版本控制系统：如 Git、SVN 等，通过本地化图片链接，可以更好地管理文档的版本历史。

通过以上步骤，你可以轻松地使用 markdown-image-localizer 管理 Markdown 文档中的图片，提升工作效率。

markdown-image-localizer🖼Fastly list or localize the images in markdowns.项目地址:https://gitcode.com/gh_mirrors/ma/markdown-image-localizer