Yuque-VitePress

Appearance

Elog配置详解 ​

参考 Elog 文档，本博客的 Elog 的配置如下：

javascript
module.exports = {
  write: {
    platform: 'yuque-pwd',
    yuque: {
      token: process.env.YUQUE_TOKEN,
      login: process.env.YUQUE_LOGIN,
      repo: process.env.YUQUE_REPO,
      onlyPublic: false,
      onlyPublished: true,
    },
    "yuque-pwd": {
      username: process.env.YUQUE_USERNAME,
      password: process.env.YUQUE_PASSWORD,
      login: process.env.YUQUE_LOGIN,
      repo: process.env.YUQUE_REPO,
      linebreak: false
    }
  },
  deploy: {
    platform: 'local',
    local: {
      outputDir: './docs/docs',
      filename: 'title',
      format: 'markdown',
      catalog: true
    }
  },
  image: {
    enable: true,
    platform: 'local',
    local: {
      outputDir: './docs/images',
      pathFollowDoc: true,
    }
  }
}
module.exports = {
  write: {
    platform: 'yuque-pwd',
    yuque: {
      token: process.env.YUQUE_TOKEN,
      login: process.env.YUQUE_LOGIN,
      repo: process.env.YUQUE_REPO,
      onlyPublic: false,
      onlyPublished: true,
    },
    "yuque-pwd": {
      username: process.env.YUQUE_USERNAME,
      password: process.env.YUQUE_PASSWORD,
      login: process.env.YUQUE_LOGIN,
      repo: process.env.YUQUE_REPO,
      linebreak: false
    }
  },
  deploy: {
    platform: 'local',
    local: {
      outputDir: './docs/docs',
      filename: 'title',
      format: 'markdown',
      catalog: true
    }
  },
  image: {
    enable: true,
    platform: 'local',
    local: {
      outputDir: './docs/images',
      pathFollowDoc: true,
    }
  }
}

语雀配置 ​

WARNING

Token 模式或者账号密码模式二选一即可，默认为账号密码模式，如果需要切换为 Token 模式，则修改platform为yuque即可

javascript
write: {
    platform: 'yuque-pwd',
    yuque: { // Token 模式
      token: process.env.YUQUE_TOKEN,
      login: process.env.YUQUE_LOGIN,
      repo: process.env.YUQUE_REPO,
      onlyPublic: false,
      onlyPublished: true,
    },
    "yuque-pwd": { // 账号密码模式
      username: process.env.YUQUE_USERNAME,
      password: process.env.YUQUE_PASSWORD,
      login: process.env.YUQUE_LOGIN,
      repo: process.env.YUQUE_REPO,
      linebreak: false
    }
  },
write: {
    platform: 'yuque-pwd',
    yuque: { // Token 模式
      token: process.env.YUQUE_TOKEN,
      login: process.env.YUQUE_LOGIN,
      repo: process.env.YUQUE_REPO,
      onlyPublic: false,
      onlyPublished: true,
    },
    "yuque-pwd": { // 账号密码模式
      username: process.env.YUQUE_USERNAME,
      password: process.env.YUQUE_PASSWORD,
      login: process.env.YUQUE_LOGIN,
      repo: process.env.YUQUE_REPO,
      linebreak: false
    }
  },
  • token为语雀Token，可从此处获取
  • username为语雀账号，一般为手机号
  • password为语雀登录密码，如果没有设置过，可在账号设置中进行设置
  • login为语雀路径，可从此处获取
  • repo为语雀仓库短名称，可从此处获取
  • onlyPublic表示是否只下载互联网公开文档
  • onlyPublished表示是否只下载已发布文档

本地配置 ​

javascript
local: {
  outputDir: './docs/docs',
  filename: 'title',
  format: 'markdown',
  catalog: true
}
local: {
  outputDir: './docs/docs',
  filename: 'title',
  format: 'markdown',
  catalog: true
}
  • outputDir表示文档的存放位置为项目根目录下的docs/docs文件夹中
  • filename表示文档将以数据库的 title 字段命名，也就是文档名
  • format表示文档将以 markdown 的形式保存
  • catalog表示文档将按照语雀知识库的现有目录存放

图床配置 ​

javascript
local: {
  outputDir: './docs/images',
  pathFollowDoc: true,
}
local: {
  outputDir: './docs/images',
  pathFollowDoc: true,
}
  • outputDir表示图片的存放位置为项目根目录下的docs/images文件夹中
  • pathFollowDoc表示图片路径会相对文档位置自动变化

更多 Elog 配置详情，请阅读 Elog 文档 ​