Skip to content

TheNorthS/yuque-dl

 
 

Repository files navigation

yuque-dl

语雀知识库下载为本地markdown

header

Install

npm i -g yuque-dl

Usage

$ yuque-dl --help

  Usage:
    $ yuque-dl <url>

  Commands:
    <url>  语雀知识库url

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

  Options:
    -d, --distDir <dir>  下载的目录 eg: -d download (default: download)
    -i, --ignoreImg      忽略图片不下载 (default: false)
    -k, --key <key>      指定语雀的 cookie key,默认是 "_yuque_session"
    -t, --token <token>  语雀的cookie key 对应的值
    -h, --help           Display this message
    -v, --version        Display version number

Start

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

Example

demo

私有知识库

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

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

token的获取请看

企业私有服务

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

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

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

Feature

  • 支持下载中断继续
  • 支持图片下载本地
  • 支持下载分享私有的知识库

Tips

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

About

yueque 语雀知识库下载

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 96.4%
  • JavaScript 3.6%