YuqueExportToMarkdown 项目教程

1. 项目的目录结构及介绍

YuqueExportToMarkdown/
├── image/
│   └── asrgu-k3t3q-001.ico
├── lake/
│   └── test.lake
├── LICENSE
├── README.md
├── requirements.txt
├── startup.py
└── yuque_export_to_markdown.spec

• image/: 存放项目相关的图片文件，例如图标。
• lake/: 存放测试用的lake文件。
• LICENSE: 项目的开源许可证文件，本项目使用Apache-2.0许可证。
• README.md: 项目的介绍文档，包含项目的基本信息和使用说明。
• requirements.txt: 项目的依赖文件，列出了项目运行所需的Python包。
• startup.py: 项目的启动文件，负责执行lake文件到markdown文件的转换。
• yuque_export_to_markdown.spec: PyInstaller打包配置文件，用于将项目打包为可执行文件。

2. 项目的启动文件介绍

startup.py

startup.py 是项目的启动文件，负责执行lake文件到markdown文件的转换。以下是该文件的主要功能和使用方法：

• 功能:

  • 支持命令行转换文件。
  • 支持直接读取lakebook格式的文件。
  • 提供可视化操作。

• 使用方法:

  • 安装依赖：pip install -r requirements.txt
  • 运行代码：

    python startup.py -i meta.json路径 -o 输出md文档路径
    python startup.py -l your_lakebook路径 -o 输出md文档路径
    

3. 项目的配置文件介绍

requirements.txt

requirements.txt 文件列出了项目运行所需的Python包。以下是该文件的内容示例：

pipreqs==0.4.10
PyInstaller==4.3

• pipreqs: 用于生成项目的依赖文件。
• PyInstaller: 用于将Python脚本打包为可执行文件。

yuque_export_to_markdown.spec

yuque_export_to_markdown.spec 是PyInstaller的打包配置文件，用于将项目打包为可执行文件。以下是该文件的主要配置项：

• name: 打包后的可执行文件名称。
• console: 是否显示命令行窗口。
• icon: 打包后的可执行文件图标。

通过这些配置，可以将 startup.py 打包为一个独立的可执行文件，方便用户在没有Python环境的机器上使用。