yuque-exporter 常见问题解决方案

yuque-exporter 常见问题解决方案

yuque-exporter A tool for exporting Yuque documents as markdown. 项目地址: https://gitcode.com/gh_mirrors/yu/yuque-exporter

项目基础介绍

yuque-exporter 是一个用于将语雀（Yuque）文档导出为 Markdown 格式的开源工具。该项目的主要功能包括：

• 模拟用户浏览器操作，一篇一篇导出 Markdown 文档。
• 按照知识库目录导出文档。
• 支持导出失败重试。
• 导出文档中的图片到本地。
• 替换文档中的图片链接。

该项目主要使用 Node.js 进行开发，依赖于 Puppeteer 库来模拟浏览器操作。

新手使用注意事项及解决方案

1. 环境配置问题

问题描述：新手在安装和配置 Node.js 环境时可能会遇到问题，尤其是在不同操作系统下。

解决方案：

• 步骤1：确保你的系统已经安装了 Node.js。你可以通过运行 node -v 和 npm -v 来检查是否已经安装。
• 步骤2：如果未安装，建议使用 nvm（Node Version Manager）来管理 Node.js 版本。你可以通过以下命令安装 nvm：

  curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash
  

• 步骤3：安装完成后，使用 nvm install <version> 安装指定版本的 Node.js，例如：

  nvm install 14.17.0
  

• 步骤4：安装项目依赖。进入项目目录后，运行：

  npm install
  

2. 浏览器环境问题

问题描述：项目依赖于 Chromium 浏览器，新手可能不清楚如何配置或确保浏览器环境正确。

解决方案：

• 步骤1：确保你的系统已经安装了 Chromium 浏览器，如 Google Chrome、Microsoft Edge、Opera 和 Brave 等。
• 步骤2：如果未安装，可以通过以下命令安装 Chromium：

  sudo apt-get install chromium-browser  # 适用于 Ubuntu/Debian
  brew install chromium  # 适用于 macOS
  

• 步骤3：在项目中配置 Puppeteer 使用已安装的 Chromium 浏览器。你可以在 main.js 文件中添加以下配置：

  const browser = await puppeteer.launch({
    executablePath: '/path/to/your/chromium',
  });
  

3. 导出图片失败问题

问题描述：在导出文档时，图片可能无法正确下载或替换链接。

解决方案：

• 步骤1：确保你已经正确配置了环境变量 MARKDOWN_DIR 和 DOWNLOAD_IMAGE。例如：

  export MARKDOWN_DIR=/path/to/markdown
  export DOWNLOAD_IMAGE=true
  

• 步骤2：检查网络连接，确保能够访问语雀服务器和图片资源。
• 步骤3：如果图片下载失败，可以尝试手动下载图片并替换链接。你可以在导出完成后，手动检查 output 目录中的图片链接，并进行替换。

通过以上步骤，新手可以更好地理解和使用 yuque-exporter 项目，解决常见的问题。

yuque-exporter A tool for exporting Yuque documents as markdown. 项目地址: https://gitcode.com/gh_mirrors/yu/yuque-exporter