yuque-exporter 技术文档

yuque-exporter 技术文档

yuque-exporter 项目地址: https://gitcode.com/gh_mirrors/yuqu/yuque-exporter

1. 安装指南

1.1 环境准备

• Node.js: 确保你的系统上已经安装了 Node.js。你可以通过运行 node -v 来检查是否已安装。如果没有安装，请前往 Node.js 官网 下载并安装。
• npm: npm 是 Node.js 的包管理工具，通常随 Node.js 一起安装。你可以通过运行 npm -v 来检查是否已安装。

1.2 安装步骤

1. 克隆项目: 首先，你需要从 GitHub 上克隆 yuque-exporter 项目到本地。

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

2. 安装依赖: 进入项目目录后，运行以下命令来安装项目所需的依赖包。

   npm install
   

2. 项目的使用说明

2.1 获取语雀 TOKEN

在使用 yuque-exporter 之前，你需要先获取语雀的 API TOKEN。请参考 语雀开发者文档 获取你的 TOKEN。

2.2 导出语雀文档

在获取到 TOKEN 后，你可以使用以下命令来导出语雀文档：

npx yuque-exporter --token=<your token>

2.3 查看帮助

如果你需要查看更多命令行选项，可以使用以下命令查看帮助文档：

npx yuque-exporter --help

3. 项目API使用文档

3.1 语雀 API 调用

yuque-exporter 项目通过调用语雀的 API 来获取文档的元数据，并将其导出为本地 Markdown 文件。API 调用的主要步骤如下：

1. 获取文档列表: 通过语雀 API 获取用户的文档列表。
2. 获取文档内容: 根据文档列表中的 ID，获取每个文档的具体内容。
3. 处理文档内容: 下载文档中的图片、替换链接等。

3.2 API 调用限制

语雀 API 有调用频率限制，目前为每小时 5000 次。如果超过限制，项目会提示用户。

4. 项目安装方式

4.1 通过 npm 安装

你可以通过 npm 全局安装 yuque-exporter，以便在任何地方使用它：

npm install -g yuque-exporter

4.2 本地安装

如果你不想全局安装，也可以在项目目录下本地安装：

npm install yuque-exporter

4.3 运行项目

安装完成后，你可以通过以下命令来运行项目：

YUQUE_TOKEN=<your token> npm start

5. 其他说明

5.1 TODO List

项目目前还有一些功能尚未完成，包括：

• 支持多账号和团队文档的下载
• 对 Obsidian 的更多支持
• API 调用受限时的提示
• 单元测试

5.2 贡献

如果你对项目有任何建议或发现了 bug，欢迎提交 issue 或 pull request。

---

通过以上文档，你应该能够顺利安装和使用 yuque-exporter 项目，将语雀文档批量导出为本地 Markdown 文件。

yuque-exporter 项目地址: https://gitcode.com/gh_mirrors/yuqu/yuque-exporter