renyunkang / yuque-exporter

A tool for exporting Yuque documents as markdown.
GNU General Public License v2.0
185 stars 28 forks source link

一个用户的使用记录和反馈 #20

Open fgc346 opened 4 months ago

fgc346 commented 4 months ago

概述

首先,非常感谢作者的这个项目,帮助我解决了导出语雀笔记的大问题。 我自己的笔记觉得是个人非常重要的一个财富,但是一篇一篇导出,除了繁琐以外,更多的是会忘记。这里作者的项目解决了燃眉之急。 这个Issue,并不是要提出什么问题,而是总结我在使用这个项目中的体验。给第一次使用项目的人做一些参考。

环境

ubuntu 22.04 系统

安装过程

首先阅读项目中README.md文件。

进行相关依赖下载。

在Ubuntu22.04上使用nvm安装Node.js和配置npm淘宝源以及安装yarn的具体步骤:

1. **安装nvm**:
   - 首先,你需要安装nvm。可以通过curl或wget从GitHub仓库安装。这里以curl为例:
     curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash

     注意:
      安装完nvm之后,相关环境变量就会设置在~/.bashrc。可以打开这个配置文件查看。

2. **关闭并重新打开终端**:
   - 安装nvm后,你需要关闭并重新打开终端,以便nvm脚本能够生效。

3. **验证nvm安装**:
   - 检查nvm是否安装成功:
     ```bash
     nvm --version
  1. 安装Node.js

    • 使用nvm安装最新版本的Node.js(或者你可以选择安装其他版本):
      nvm install node
  2. 设置默认Node.js版本

    • 将安装的Node.js版本设置为默认版本:
      nvm alias default node
  3. 配置npm淘宝源

    • 运行以下命令来配置npm使用淘宝源:
      npm config set registry https://registry.npmmirror.com
  4. 安装yarn

    • 使用npm和淘宝源全局安装yarn:
      npm install -g yarn --registry=https://registry.npmmirror.com
  5. 验证yarn安装

    • 检查yarn是否安装成功:
      yarn --version
  6. 使用Node.js和yarn

    • 安装好了相关依赖之后,就可以使用Node.js和yarn来创建和管理语雀导出这个项目。

下载yuque-exporter工程

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

使用过程记录

下载个人语雀知识库

进入yuque-exporter项目后。 执行下载知识库的命令

# 第一次运行时,使用 USER + PASSWORD 登录
# USER=xxx PASSWORD=xxx node main.js
USER=xxx PASSWORD=xxx  node main.js

注意关于导出路径 我没有设置导出路径,执行上述命令,会在yuque-exporter下面创建output文件夹。

执行上述命令报错。 不能找到 puppeteer 这个包。 执行下面执行安装包。

yarn add puppeteer

运行指令之后,就等待程序自动执行,会把所有的知识库下载到output文件夹下面。 注意 执行上述main.js之后,无论是文档中的图片,还是笔记中的图片链接,并没有下载到本地笔记中。

文档中图片下载到本地文档

参考作者提供的额外功能。我是想把图片下载到本地,并且更新文档中的图片链接为本地相对路径。

设置环境变量

# 下载图片到本地标志
export DOWNLOAD_IMAGE="true"

# 同时更新文档中的图片路径
export UPDATE_MDIMG_URL="true"

运行下载图片并更新笔记图片路径

python3 export-image.py

总结

以上就是我使用这个项目的记录,后续还有单独下载某个知识库的需求,这个issue有人已经提出方案,尝试后,在给大家更新使用体验。

fgc346 commented 2 months ago

后续问题跟进

问题

运行 node main.js 不能拉取语雀笔记。

运行 USER=*** PASSWORD=*** node main.js 仍然无法拉取。

后续排查发现问题。

解决方案

删除文件夹下面的cookies.json这个文件。 这里存储的是账号的各种信息。 然后重新使用账号和密码运行。 USER=*** PASSWORD=*** node main.js 执行命令,正常拉取所有知识库到本地。