yuque2md 项目使用指南

yuque2md 项目使用指南

yuque2md 项目地址: https://gitcode.com/gh_mirrors/yu/yuque2md

1. 项目目录结构及介绍

yuque2md 项目遵循简洁的目录布局，以下是主要组成部分：

yuque2md/
├── static/
│   └── DS_Store
├── LICENSE
├── README.md
└── main.py

• static/: 存储静态文件的目录，例如图片等。
• LICENSE: 项目的开源许可证文件，本项目使用 CC0-1.0 许可证。
• README.md: 项目的主要文档，包含了项目简介、快速入门指导和一些基本的使用说明。
• main.py: 主入口文件，程序的核心逻辑在此启动。

2. 项目的启动文件介绍

main.py

main.py 是项目的启动点，包含了主函数 main，它负责初始化程序，调用核心逻辑来处理语雀导出的 Markdown 文件，并将其中的图片链接转换为本地链接。

用户可以通过命令行参数与程序交互，具体用法如下：

python main.py [origin_md_path] [output_md_path] [image_dir] [image_url_prefix] [image_rename_mode]

• origin_md_path: 输入的 Markdown 文件路径。
• output_md_path: 输出的 Markdown 文件路径。
• image_dir: 图片存储的目录。
• image_url_prefix: 图片链接前缀，可以是空字符串、路径或 CDN 地址。
• image_rename_mode: 图片重命名模式，raw 表示原始 UUID 模式，asc 表示递增重命名模式。

示例：

python main.py raw.md out.md images '' raw

3. 项目的配置文件介绍

yuque2md 项目没有提供独立的配置文件，所有的配置都是通过命令行参数传递的。用户可以根据需要设置不同的参数来定制化工具的行为。

例如，可以通过设置 image_url_prefix 参数来指定图片链接的前缀，或者通过 image_rename_mode 参数来控制图片的重命名方式。

python main.py raw.md out.md images 'http://cdn.xx.xx/' asc

以上命令会将 raw.md 文件中的图片下载到 images 目录，并将图片链接前缀设置为 http://cdn.xx.xx/，同时使用递增重命名模式。

通过以上介绍，您应能够初步了解 yuque2md 项目的基本架构、启动方式以及如何通过命令行参数进行配置。

yuque2md 项目地址: https://gitcode.com/gh_mirrors/yu/yuque2md