Skip to content

markyun/yuque-exporter

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

语雀导出文档工具 (支持单独导出指定知识库)

主要特色:不依赖语雀VIP才有的Token,原理是模拟用户浏览器操作一篇一篇导出 markdown 文档。

文档在这里:https://markyun.github.io/blog/语雀文档导出工具/

源码基于 https://github.com/renyunkang/yuque-exporter.git 的版本进行微调修改,DIY成了自己用的版本。

快速使用

下载代码并安装依赖

cd yuque-exporter
npm install  

// chromium 在mac上默认安装英特尔版本,如果想安装M1版本需要使用下面方式安装
PUPPETEER_EXPERIMENTAL_CHROMIUM_MAC_ARM=1 npm install puppeteer

brew reinstall chromium
  

运行node命令

USER=xxx PASSWORD=xxx  node main.js

// Mac系统 下载图片
python3 export-image.py

// 需要先安装 requests
pip3 install requests


                                  

下载制定知识库

ps: 因为有些同学,知识库或文章太多,不需要全量下载(也会引起请求次数太多,超时失败),所以只下载需要的 books 知识库。可以在 getAllBooks 函数中,拿到 bookData 数据后进行判断。

    // yuque-exporter-mjy/main.js 57 lines
    // 这里可以传入指定的知识库 ID
    // https://www.yuque.com/api/mine/book_stacks 值通过这个接口获取 
    const booksId = '';
    const books = await getAllBooks(page,booksId)
    

通过 https://www.yuque.com/api/mine/book_stacks 接口获取 全部 bookData 内容,拿到想要的 object.books[i].id。

通过https://www.yuque.com/api/catalog_nodes?book_id=173556 +id 可以得到当前知识库的全部文章列表 getBookDetail 内容。(这样相当于,如果你想下载别人开放的知识库,也是可以DIY代码实现)

语雀文档格式 处理

url 后面跟上下方的参数,也可以直接获取单篇文档的markdown格式。

/markdown?plain=true&linebreak=false&anchor=false
?view=doc_embed&from=kb&from=kb&outline=1&title=1

替换语雀图片后缀 这个步骤将会删除保存的图片的多余部分,使图片能够正常显示。这个方法无需运行脚本,只需要使用 Markdown 编辑器进行简单的文本替换操作即可解决问题。

<!-- 正侧替换为空  -->
#averageHue=[a-zA-Z0-9\-&=%\.]*

<!-- 同时项目的HTML头,添加下面的信息 -->

["meta", { name: "referrer", content: "no-referrer" }],

下面开始,是仓库原始介绍内容。

功能:

  • 模拟用户浏览器操作一篇一篇导出 markdown 文档
  • 按照知识库目录导出文档
  • 支持导出失败重试
  • 导出文档中的图片到本地
  • 替换文档中的图片链接

ps: 后面两个功能是使用 python 实现,可以单独使用

效果展示:

image.png

image.png

动图展示(旧版图,新版未更新图):image.png

说明:

这是一个基于puppeteer 来模拟用户在浏览器的操作一篇一篇的导出语雀文档的工具。 关于语雀的导出可以详情说明见官方的文档:如何导入导出知识库

首先语雀支持导出文档为 markdown 格式。

  • 单篇导出:支持导出为 markdown、word、pdf、lakebook等
  • 批量导出:支持导出为 lakebook、pdf 格式。对于超级用户是可以通过创建 token 来使用官方的 exporter 工具或者其他基于 api 的工具进行批量导出;超级用户的价格为 299/年。

lakebook 格式为语雀私有的格式:lakebook 格式说明,语雀也没有相应的工具去支持迁移/导入到其他笔记软件。pdf 估计也不能直接导入其他笔记软件(这个没有研究过就不展开了)。

因此对于想要迁移自己文档的普通用户以及会员用户来说,你只能一篇一篇导出来完成你的迁移动作,这些用户也大多有上百篇文档,这无疑是劝退。所以我的迁移计划也一再搁置,同时也再等待其他的更友好的导出方式出现。最后还是不想等了,请教 GPT 写了这个工具,确实也怕像我这种白嫖用户之后的迁移的成本越来越大了。

ps: 本人也不是专门写 nodejs 的,代码可能也是烂成狗屎,请大家不喜勿喷。谢谢!

使用:

确保你的环境有 Chromium 浏览器。如 Google Chrome、Microsoft Edge、Opera 和 Brave等,都是基于 Chromium 浏览器构建的。

1. 安装 node 相关的工具

建议使用 nvm 管理 node,选取下列适合自己的方式安装:

配置 npm 淘宝源:npm config set registry https://registry.npmmirror.com

安装 yarn:npm install -g yarn --registry=https://registry.npmmirror.com

2. 下载代码并导出

下载代码并安装依赖

git clone https://github.com/renyunkang/yuque-exporter.git
cd yuque-exporter
npm install --registry=https://registry.npm.taobao.org
# 安装 JSONStream:
# npm install JSONStream --registry=https://registry.npm.taobao.org

# yarn 安装依赖如果下载报错的话,可以依据情况更换源。
yarn

设置环境变量并使用工具导出

需要用到的环境变量:

环境变量 选项 描述
USER 必须(有cookie文件时非必须) 登录的用户名
PASSWORD 必须(有cookie文件时非必须) 登录的密码
EXPORT_PATH 非必须 指定导出路径,默认为当前工作目录下的 output 目录(自动创建)
  • ubuntu
# 第一次运行时,使用 USER + PASSWORD 登录
# USER=xxx PASSWORD=xxx node main.js
USER=xxx PASSWORD=xxx EXPORT_PATH=/path/to/exporter node main.js

# 登录一次后会保存 cookie,之后使用cookie登录
# node main.js
EXPORT_PATH=/path/to/exporter node main.js
  • windows
# 1. cmd
set USER="xxx"
set PASSWORD="xxx"
# set EXPORT_PATH=/path/to/exporter
node main.js

# 2. powershell
# $env:USER="xxx";$env:PASSWORD="xxx"; node .\main.js
$env:USER="xxx";$env:PASSWORD="xxx";$env:EXPORT_PATH="/path/to/exporter"; node .\main.js
  • MacOS
# 密码有特殊字符,建议单引号处理
export USER='xxx'
export PASSWORD='xxx'

# 运行
node main.js

3. 导出文档中的图片

需要用到的几个环境变量:

环境变量 选项 描述
MARKDOWN_DIR 非必须 指定 mardown 文件夹路径,默认为当前工作目录的 output 目录
DOWNLOAD_IMAGE 非必须 指定是否导出图片,导出路径为 MARKDOWN_DIR 目录下的 images 目录,默认为 true
UPDATE_MDIMG_URL 非必须 指定是否更新文件中的图片路径,未指定 REPLACE_IMAGE_HOST 时,会更新为图片路径的相对路径。默认为 false
REPLACE_IMAGE_HOST 非必须 更新图片路径时自定义文件 url,格式为:{REPLACE_IMAGE_HOST}/{years}/{img_name},在使用自定义对象存储时,建议上传图片时的路径符合前面的格式;默认为空

使用工具导出

# 以 windows powershell 为例
# 下载图片,不更新 mardown 源文件的图片链接
python.exe .\export-image.py

# 不下载图片,更新文件的图片为相对路径
$env:DOWNLOAD_IMAGE="false";$env:UPDATE_MDIMG_URL="true"; python.exe .\export-image.py

# 不下载图片,更新文件的图片为自定义对象存储(自定义域名)
$env:DOWNLOAD_IMAGE="false";$env:UPDATE_MDIMG_URL="true"; $env:REPLACE_IMAGE_HOST="https://images.ryken.cloud/"; python.exe .\export-image.py

ps:

  1. 当使用 python 运行时,如果没有相关依赖的话,需要手动下载一下; pip install xxx
  2. 相关环境变量的是指同上面"下载代码并导出"
  3. 根据自己需要,指定不同环境变量的值,来满足不同的需求吧

存在的问题:

1.自动登录仅支持账号密码登录

2.无法保证兼容性,如果之后官方 api 修改后,可以自己根据 api 修改源码

3.无法导出内容为纯表格/思维导出的文档(官方也不支持将其直接导出为 markdown);因此报错的 timeout,可能为这些类型的文档,请重复确认后手动导出为其他格式。

4.团队的导出未测试

Q&A

  1. Could not find Chromium 但是有 chorm 浏览器 在不同的操作系统上,Puppeteer 默认调用的 Chrome 路径如下:
  • Windows: C:\Program Files (x86)\Google\Chrome\Application\chrome.exe
  • macOS: /Applications/Google Chrome.app/Contents/MacOS/Google Chrome
  • Linux: /usr/bin/google-chrome 如果主机上对应的可执行文件路径与默认一致但仍然运行失败,可以修改源码手动指定一下,如果没有chorme也可以执行edge的二进制文件 image.png
const browser = await puppeteer.launch({ headless: true });
 to
const browser = await puppeteer.launch({ headless: true, executablePath: '/usr/bin/google-chrome' });
 or
// headless: false 会打开浏览器实时观察模拟的操作,可用于调试;executablePath 替换为自己本机对应路径
const browser = await puppeteer.launch({ headless: false, executablePath: "C:\\Program Files (x86)\\Microsoft\\Edge\\Application\\msedge.exe" });

About

A tool for exporting Yuque documents as markdown. support exporting a single knowledge base

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 79.8%
  • Python 20.2%