https://github.com/fxbin/yuque-toolbox

yuque-toolbox
https://github.com/fxbin/yuque-toolbox

Last synced: 10 months ago
JSON representation

yuque-toolbox

• Host: GitHub
• URL: https://github.com/fxbin/yuque-toolbox
• Owner: fxbin
• License: apache-2.0
• Created: 2023-08-02T07:46:51.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-11-12T09:48:19.000Z (over 2 years ago)
• Last Synced: 2025-05-16T08:43:58.791Z (about 1 year ago)
• Language: Java
• Size: 665 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# yuque-toolbox

## 用途描述

> 便于个人导出备份， 同时提供Java版本 yuque-sdk 

> 

> 目前仅支持markdown文档导出，其它类型文档暂未实现

## 环境&版本

* spring-boot 3.1.2

* forest 1.5.32

## 模块

* yuque-export  语雀文档导出主程序

* yuque-sdk  语雀api sdk实现

### yuque-sdk 用法

```yaml

yuque:

  # 默认值即为 ： https://www.yuque.com/api/v2

  base-url: https://www.yuque.com/api/v2

  # 语雀token

  token: token

  # 文档导出路径

  export:

    path: /data

```

### yuque-export 用法

1. 安装java环境（**jdk17**）

2. 指定配置变量（语雀token, 导出路径）,如下所示

![](images/语雀导出配置变量截图.png)

3. 启动项目

> 1. 直接源码启动

> 2. jar 文件启动, 启动命令如下：

> > java -jar yuque-export.jar --yuque.token={语雀token} --yuque.export.path={文件导出路径}

4. 访问 http://127.0.0.1:9000/doc.html, 效果图如下:

![语雀导出接口文档效果图](images/语雀导出接口文档.png)

### yuque token 获取方法

![yuque token 获取方法](images/语雀token%20获取方式.png)

## 语雀文档

[开发者文档](https://www.yuque.com/yuque/developer)