Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gxr404/yuque-dl

yueque 语雀知识库下载
https://github.com/gxr404/yuque-dl

cli download markdown nodejs yuque yuque-dl

Last synced: 14 days ago
JSON representation

yueque 语雀知识库下载

Host: GitHub
URL: https://github.com/gxr404/yuque-dl
Owner: gxr404
Created: 2023-08-14T07:05:04.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2023-11-06T10:12:20.000Z (about 1 year ago)
Last Synced: 2023-12-16T15:47:25.626Z (11 months ago)
Topics: cli, download, markdown, nodejs, yuque, yuque-dl
Language: TypeScript
Homepage:
Size: 1.02 MB
Stars: 34
Watchers: 3
Forks: 3
Open Issues: 1
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# yuque-dl

语雀知识库下载为本地markdown

![header](https://socialify.git.ci/gxr404/yuque-dl/image?description=1&descriptionEditable=%E8%AF%AD%E9%9B%80%E7%9F%A5%E8%AF%86%E5%BA%93%E4%B8%8B%E8%BD%BD&issues=1&logo=https%3A%2F%2Fraw.githubusercontent.com%2Fgxr404%2Fyuque-dl%2Fmain%2Fdocs%2Fassets%2Flogo.png&name=1&pattern=Circuit%20Board&pulls=1&stargazers=1&theme=Light)

## Prerequisite

- Node.js 18.4 or later

## Install

```bash
npm i -g yuque-dl
```

## Usage

```bash
$ yuque-dl --help

Usage:
$ yuque-dl

Commands:
语雀知识库url
server 启动web服务

For more info, run any command with the `--help` flag:
$ yuque-dl --help
$ yuque-dl server --help

Options:
-d, --dist-dir 下载的目录 eg: -d download (default: download)
-i, --ignore-img 忽略图片不下载 (default: false)
-k, --key 语雀的cookie key，默认是 "_yuque_session"，在某些企业版本中 key 不一样
-t, --token 语雀的cookie key 对应的值
--toc 是否输出文档toc目录 (default: false)
-h, --help Display this message
-v, --version Display version number
```

### Start

```bash
# url 为对应需要的知识库地址
yuque-dl "https://www.yuque.com/yuque/thyzgp"
```

## Example

![demo](https://github.com/gxr404/yuque-dl/assets/17134256/98fbbc81-91d4-47f8-9316-eb0ef060d6be)

## 其他场景

### 私有知识库

通过别人私有知识库分享的链接，需使用`-t`添加token才能下载

```bash
yuque-dl "https://www.yuque.com/yuque/thyzgp" -t "abcd..."
```

[token的获取请看](./docs/GET_TOEKN.md)

### 企业私有服务

企业服务有自己的域名(黄色语雀logo)，非`yuque.com`结尾, 如`https://yuque.antfin.com/r/zone`

这种情况 token的key不唯一, 不一定是为`_yuque_session` 需用户使用 `-k` 指定 token的key,`-t` 指定 token的值。

至于`key`具体是什么只能靠用户自己在 `浏览器Devtools-> Application -> Cookies` 里找了🤔

### 公开密码访问的知识库

![public_pwd](https://github.com/gxr404/yuque-dl/assets/17134256/b546a9a3-68f0-4f76-b450-6b16f464db5d)

⚠️ 公开密码访问的知识库两种情况:

- 已经登录语雀，访问需要密码的知识库输入密码后使用`_yuque_session`这个cookie

```bash
yuque-dl "url" -t "_yuque_session的值"
```

- 未登录语雀，访问需要密码的知识库输入密码后需要使用`verified_books`/`verified_docs`这个cookie

```bash
yuque-dl "url" -k "verified_books" -t "verified_books的值"
```

## 内置启动web服务可快速预览

使用[`vitepress`](https://vitepress.dev/)快速启动一个web服务提供可预览下载的内容

```bash
yuque-dl server ./download/知识库/

➜ Local: http://localhost:5173/
➜ Network: use --host to expose
```

![server](https://github.com/gxr404/yuque-dl/assets/17134256/6d3a06cd-20b1-4eca-ae75-d9a90614336f)

## Feature

- [x] 支持下载中断继续
- [x] 支持图片下载本地
- [x] 支持下载分享私有的知识库
- [x] 支持转换表格类型的文档 (ps: 表格内插入图表暂不支持)
- [x] 添加toc目录功能
- [x] 添加测试
- [x] 添加附件下载
- [ ] 支持其他文档类型？🤔
- [ ] 直接打包成可执行文件 🤔

## 常见错误

1. 由于token可能含有特殊字符导致参数识别错误

```bash
yuque-dl "https://www.yuque.com/yuque/thyzgp" -t "-a123"
yuque-dl [ERROR]: Unknown option `-1`
```

解决方案

```bash
yuque-dl "https://www.yuque.com/yuque/thyzgp" -t="-a123"
```

2. 附件下载失败，需设置登录token

附件文件下载需要用户登录token，即使是完全公开的知识库，下载附件也可能需要

完全公开的知识库未登录的情况下查看附件:

![attachments](https://github.com/user-attachments/assets/6e764abf-0da6-4fb8-ab96-7d027830b291)

## Tips

由于网络波动下载失败的，重新运行即可，已下载的进度不会受到影响