语雀文档导出工具(yuque-exporter)安装与配置完全指南

最新推荐文章于 2025-02-24 18:59:30 发布

高煊翔

最新推荐文章于 2025-02-24 18:59:30 发布

阅读量2.4k

点赞数 8

本文链接：https://blog.csdn.net/gitblog_09353/article/details/142221011

版权

语雀文档导出工具(yuque-exporter)安装与配置完全指南

项目地址:https://gitcode.com/gh_mirrors/yu/yuque-exporter

项目基础介绍

yuque-exporter 是一个专为语雀(Yuque)用户设计的开源工具，它允许用户便捷地将语雀上的文档导出为Markdown格式，并且支持文档结构导出、图片资源下载等功能。该项目采用 Node.js 和 Puppeteer 技术栈实现，确保能够模拟真实用户的浏览器行为，从而绕过一些自动化限制。

主要编程语言及关键技术

主要编程语言: JavaScript (Node.js)
关键技术和框架:
- Node.js: 提供服务器端JavaScript运行环境。
- Puppeteer: 一个无头浏览器库，用于自动化网页交互，比如登录和导出文档。
- Python (部分功能): 用于处理图片下载和Markdown中图片路径替换，增加了灵活性。
- JSONStream: 可选依赖，用于高效处理大量JSON数据流。

准备工作与详细安装步骤

系统要求

适用于Windows, macOS, 和Linux系统。
需要Chromium或Chrome浏览器（或其他基于Chromium的浏览器）。

步骤1: 环境配置

Node.js与npm/yarn安装

Node.js: 访问 Node.js官网下载并安装适合您系统的版本。
npm 自带于Node.js，无需额外安装；若需使用 yarn，可通过 npm install -g yarn 或访问 Yarn官网获取。

添加淘宝镜像（可选）

对于更快的下载速度，可以设置npm使用淘宝镜像：
```
npm config set registry https://registry.npm.taobao.org
```

安装yarn时，同样推荐使用淘宝源：

npm install -g yarn --registry=https://registry.npm.taobao.org

步骤2: 项目克隆与依赖安装

打开终端或命令提示符。

克隆项目到本地:

git clone https://github.com/renyunkang/yuque-exporter.git

进入项目目录:
```
cd yuque-exporter
```

安装项目依赖:

npm install --registry=https://registry.npm.taobao.org

步骤3: 环境变量配置与导出前准备

重要环境变量:
- USER: 登录的用户名。
- PASSWORD: 登录的密码。
- EXPORT_PATH: 导出路径，默认为./output。
- MARKDOWN_DIR, DOWNLOAD_IMAGE, UPDATE_MDIMG_URL, REPLACE_IMAGE_HOST: 用于控制图片导出和Markdown图片链接更新的相关选项（非必须，视需求配置）。

在不同系统中设置环境变量:

Windows:

set USER=您的用户名
set PASSWORD=您的密码
node main.js

图片导出与Markdown链接更新配置示例:

set DOWNLOAD_IMAGE=false
set UPDATE_MDIMG_URL=true
node \export-image.py

macOS/Linux:

export USER="您的用户名"
export PASSWORD="您的密码"
node main.js

图片处理示例:

export DOWNLOAD_IMAGE=false
export UPDATE_MDIMG_URL=true
python export-image.py

步骤4: 开始导出

文档导出: 配置好环境变量后，只需运行：
```
node main.js
```
注意，首次运行需要输入用户名和密码登录，之后可能会保存cookie以避免再次输入。
图片下载与Markdown链接更新: 若需下载图片或更新Markdown内的图片链接，使用Python脚本：
```
python export-image.py
```