ChangePicBed 项目使用教程

ChangePicBed 项目使用教程

ChangePicBed 项目地址: https://gitcode.com/gh_mirrors/ch/ChangePicBed

1. 项目的目录结构及介绍

ChangePicBed 项目的目录结构如下：

ChangePicBed/
│
├── config/
│   └── config.yaml
│
├── model/
│   ├── config.go
│   ├── markdownInfo.go
│   ├── yuqueBookStacks.go
│   ├── readFile.go
│   ├── uploadCOS.go
│   └── writeFile.go
│
├── utils/
│   ├── changePicBed.go
│   ├── check.go
│   ├── clear.go
│   ├── downloadImages.go
│   ├── printConfig.go
│   ├── readFile.go
│   ├── uploadCOS.go
│   └── writeFile.go
│
├── yuque/
│   ├── exportBook.go
│   └── getBookStacks.go
│
├── .gitignore
├── go.mod
├── go.sum
├── LICENSE
├── main.go
└── README.md

目录结构介绍

• config/: 存放项目的配置文件 config.yaml。
• model/: 存放项目的模型文件，包括配置模型、Markdown 信息模型、语雀书籍栈模型等。
• utils/: 存放项目的工具函数文件，包括图片床更换、检查、清理、图片下载、配置打印等功能。
• yuque/: 存放与语雀相关的功能文件，包括导出书籍和获取书籍栈的功能。
• .gitignore: Git 忽略文件列表。
• go.mod: Go 模块文件，定义项目的依赖。
• go.sum: Go 模块的校验文件。
• LICENSE: 项目的开源许可证文件。
• main.go: 项目的启动文件。
• README.md: 项目的说明文档。

2. 项目的启动文件介绍

项目的启动文件是 main.go。该文件是整个项目的入口，负责初始化配置、调用相关功能模块，并启动程序。

main.go 文件内容概述

package main

import (
    // 导入相关包
)

func main() {
    // 初始化配置
    // 调用相关功能模块
    // 启动程序
}

3. 项目的配置文件介绍

项目的配置文件位于 config/config.yaml。该文件包含了项目的各项配置参数，如输入文件目录、输出文件目录、临时文件目录、图片床服务提供商、腾讯云 COS 配置、语雀配置等。

config.yaml 文件内容示例

# 输入文件目录
input_dir: "input"

# 输出文件目录
output_dir: "output"

# 临时文件目录
temp_dir: "temp"

# 图片床服务提供商，可选 (COS)
pic_bed: "cos"

# 腾讯云 COS 配置
cos_config:
  bucket_name: "yvling-typora-image-125xxxxxxx"
  bucket_area: "ap-nanjing"
  pic_path: "typora"
  secret_id: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
  secret_key: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

# 语雀配置
yuque_config:
  _yuque_session: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
  yuque_ctoken: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
  export_path: "yuque_export"

配置文件参数说明

• input_dir: 输入文件目录，指定需要处理的 Markdown 文件所在的目录。
• output_dir: 输出文件目录，指定处理后的 Markdown 文件输出的目录。
• temp_dir: 临时文件目录，用于存放临时文件。
• pic_bed: 图片床服务提供商，目前支持腾讯云 COS。
• cos_config: 腾讯云 COS 配置，包括存储桶名称、区域、图片路径、密钥 ID 和密钥。
• yuque_config: 语雀配置，包括语雀会话、语雀 ctoken 和导出路径。

通过以上配置，项目可以批量处理 Markdown 文件中的图片链接，并将其上传到指定的图片床服务中。

ChangePicBed 项目地址: https://gitcode.com/gh_mirrors/ch/ChangePicBed