csdnsynchexo/README.md

支持csdn/博客园/掘金/segmentfault/腾讯云加社区等平台一键迁移hexo

<h1 align="center">Welcome to csdnsynchexo 👋</h1>
<p>
  <a href="https://www.npmjs.com/package/csdnsynchexo" target="_blank">
    <img alt="Version" src="https://img.shields.io/npm/v/csdnsynchexo.svg">
  </a>
  <a href="https://github.com/flytam/CsdnSyncHexo#readme" target="_blank">
    <img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" />
  </a>
  <a href="https://github.com/flytam/CsdnSyncHexo/graphs/commit-activity" target="_blank">
    <img alt="Maintenance" src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" />
  </a>
    <a href="https://npmjs.org/package/csdnsynchexo" target="_blank">
    <img alt="download" src="https://img.shields.io/npm/dm/csdnsynchexo.svg?style=flat-square" />
  </a>
  <a href="https://github.com/flytam/CsdnSyncHexo/blob/master/LICENSE" target="_blank">
    <img alt="License: MIT" src="https://img.shields.io/github/license/flytam/csdnsynchexo" />
  </a>
</p>

> 支持 csdn/博客园/掘金/segmentfault/腾讯云加社区/github 等平台一键迁移 hexo

## Usage

### cli 使用

> 请安装 Node.js >= 18

```bash
# help
npx csdnsynchexo@latest  --help
# 命令行
npx csdnsynchexo@latest --userId 289926799429704 --type juejin --output ./example
# or 指定配置文件
npx csdnsynchexo@latest --config ./config.json
{
  "userId": "289926799429704",
  "type": "juejin",
  "output": "./example"
}
```

![example](assets/example.gif)

### api 使用

```js
const { run } = require('csdnsynchexo')
const config = {
  userId: '289926799429704',
  type: 'juejin',
  output: './example',
}
run(config).then((res) => {
  console.log(res)
  //   {
  //   title: string
  //   date: string
  //   tags: string[]
  //   categories: string[]
  //   content: string
  // }[]
})
```

### 交互式输入 TODO

#### 支持平台

**csdn**

- type csdn
- userId
  csdn 用户名。如`https://blog.csdn.net/flytam`的 flytam

- output
  输出路径。默认`.`

- cookie
  - csdn cookie 信息，不提供则使用爬虫获取；提供则 api 获取
  - 获取方式：新开一个页面，`F12(mac: cmd+shift+i)`打开控制台，[点击](https://blog-console-api.csdn.net/v1/editor/getArticle?id=104101476)抓包这个请求的`request headers`中的`cookie`后面那段值

**掘金**

- type juejin
- userId
  掘金用户 id。如`https://juejin.cn/user/289926799429704/posts`的`289926799429704`
- output
  输出路径。默认`.`

- cookie
  掘金 cookie 信息。不提供使用非鉴权 api，部分老文章 markdown 格式可能有问题

**博客园**

- type bokeyuan
- userId
  博客园用户 id。如`https://www.cnblogs.com/flytam/`的`flytam`
- output
  输出路径。默认`.`

**segmentfault**

- type segmentfault
- userId
  segmentfault id。如`https://segmentfault.com/u/flytam`的`flytam`
- output
  输出路径。默认`.`

**腾讯云加社区**

- type tengxunyun
- userId
  腾讯云加社区 id。如`https://cloud.tencent.com/developer/user/1132538/articles`的`1132538`
- output
  输出路径。默认`.`

**github issue 博客**

- type github
- userId
  githun 用户名，如`https://github.com/flytam`的 flytam
- repo
  写博客的仓库，如`https://github.com/flytam/blog`的 blog

  **掘金小册**

- type juejin_book
- userId 掘金小册 id，如https://juejin.cn/book/7070324244772716556 的 7070324244772716556
- cookie 掘金已购买小册的账号 cookie 信息

## 高级选项 beta

#### 图片自动转存

- imgConfig 图片转存配置文件

部分网站有防盗链功能，支持配置自动转存，转存功能使用了[PicGo](https://github.com/Molunerfinn/PicGo)。具体配置可[参考 1](https://picgo.github.io/PicGo-Core-Doc/zh/guide/config.html#picbed-github) [参考 2](https://picgo.github.io/PicGo-Doc/zh/guide/config.html#github%E5%9B%BE%E5%BA%8A)

例如：爬取掘金上的文章，图片转存上传到 github 上

1、新建一个 PiGo 配置文件，如（更多配置请参考 picgo）

```json
// img.json
{
  "picBed": {
    "uploader": "github",
    "github": {
      "repo": "flytam/cdn",
      "token": "xxxxx",
      "path": "img/"
    }
  }
}
```

2、执行

```bash
npx csdnsynchexo@latest --config ./config.json
{
  "userId": "xxxx",
  "type": "juejin",
  "output": "./example",
  "imgConfig": "./img.json"
}
```

tips:网络原因呢转存 github 很容易超时。建议选择其它平台，参考 picgo

## Run tests

```sh
# todo 简单测测
npm run test
```

## Author

👤 **flytam**

- Website: github.com/flytam/blog
- Github: [@flytam](https://github.com/flytam)

## 🤝 Contributing

Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](https://github.com/flytam/CsdnSyncHexo/issues). You can also take a look at the [contributing guide](https://github.com/flytam/CsdnSyncHexo/blob/master/CONTRIBUTING.md).

## Show your support

Give a ⭐️ if this project helped you!

## 📝 License

Copyright © 2020 [flytam](https://github.com/flytam).<br />
This project is [MIT](https://github.com/flytam/CsdnSyncHexo/blob/master/LICENSE) licensed.