Markdown 工具箱使用教程

Markdown 工具箱使用教程

Markdown-Toolbox Move your Markdown to another folder along with it's relatively refered pics and attachments. 项目地址: https://gitcode.com/gh_mirrors/ma/Markdown-Toolbox

1. 项目介绍

Markdown 工具箱 是一个用于管理 Markdown 笔记的工具集，由 HaujetZhao 开发并开源在 GitHub 上。该项目的主要功能包括：

• 复制：批量将 Markdown 笔记及其相对路径引用的图片和附件复制或移动到另一个指定的文件夹。
• 离线化：批量将 Markdown 笔记中的在线图片、附件、绝对路径引用的文件下载或移动到笔记的相对路径文件夹中，并将原始笔记中的绝对路径改为相对路径。
• 清理：批量清理 Markdown 相对路径索引的文件夹中已不再被引用的图片。

2. 项目快速启动

安装

首先，确保你已经安装了 Python 3。然后使用以下命令安装 Markdown-Toolbox：

pip install Markdown-Toolbox

使用

安装完成后，你可以通过以下命令启动 Markdown-Toolbox：

MarkdownToolbox

或者：

Markdown-Toolbox

从源码启动

如果你希望从源码启动，可以按照以下步骤操作：

1. 克隆仓库到本地：

   git clone https://github.com/HaujetZhao/Markdown-Toolbox.git
   cd Markdown-Toolbox
   

2. 安装依赖：

   pip install -r requirements.txt
   

3. 启动程序：

   python __init__.py
   

3. 应用案例和最佳实践

案例1：整理 Markdown 笔记

假设你有一系列的 Markdown 笔记，每个笔记都引用了同一目录下的 assets 文件夹中的图片。当你需要将这些笔记移动到另一个文件夹时，手动复制图片会非常繁琐。使用 Markdown-Toolbox 的 复制 功能，你可以轻松地将笔记及其引用的图片一起移动到新目录。

案例2：离线化网络文章

通过浏览器插件（如简悦）保存的网络文章通常包含在线图片链接。为了避免这些链接失效，你可以使用 Markdown-Toolbox 的 离线化 功能，将所有在线图片下载到本地，并更新 Markdown 文件中的链接。

案例3：清理未引用的图片

在使用 Markdown 编辑器（如 Typora）时，删除文档中的图片引用并不会自动删除实际的图片文件。随着时间的推移，assets 文件夹中可能会积累大量未被引用的图片。使用 Markdown-Toolbox 的 清理 功能，你可以轻松地删除这些未被引用的图片，释放磁盘空间。

4. 典型生态项目

Typora

Typora 是一个流行的 Markdown 编辑器，支持实时预览和多种主题。Markdown-Toolbox 可以与 Typora 结合使用，帮助用户更好地管理 Markdown 笔记中的图片和附件。

Joplin

Joplin 是一个开源的笔记应用程序，支持 Markdown 格式。通过与 Markdown-Toolbox 结合，用户可以更方便地整理和管理 Joplin 中的 Markdown 笔记。

Obsidian

Obsidian 是一个基于 Markdown 的笔记应用，强调链接和知识图谱。Markdown-Toolbox 可以帮助用户在 Obsidian 中更高效地管理笔记中的图片和附件。

通过这些工具的结合使用，用户可以更高效地管理和整理 Markdown 笔记，提升工作效率。

Markdown-Toolbox Move your Markdown to another folder along with it's relatively refered pics and attachments. 项目地址: https://gitcode.com/gh_mirrors/ma/Markdown-Toolbox