Skip to content
This repository has been archived by the owner on Mar 9, 2023. It is now read-only.

Commit

Permalink
Update example configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
Android-KitKat committed Dec 6, 2020
1 parent bfc9586 commit a207def
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 7 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -105,3 +105,6 @@ dist

# Visual Studio Code files
.vscode/

# Configuration file
config.yml
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
# twikoo-import-tools-typecho
[Typecho][Twikoo] 迁移脚本

[@Android] 制作

## 准备
在使用前需要有可供连接的 [MySQL] 数据库,其中存放着 [Typecho] 的数据。
在使用前需要有可连接的相应数据库,存放 [Typecho] 的数据。

没有相关环境的话,可在本地使用 [XAMPP] 来快速搭建。
### 关于[MySQL]的建议
如果没有 [MySQL] 环境,可在本地使用 [XAMPP] 来快速搭建。

之后再使用附带的 [phpMyAdmin][Typecho] 的数据导入数据库
之后再使用附带的 [phpMyAdmin][Typecho] 的数据库备份导入

## 使用
1. 安装 [Git][Node.js]
Expand All @@ -19,14 +22,18 @@

4. 运行`npm install`,安装依赖。

5. 编辑`config.yml`文件,填入正确的配置
5. 复制`config.example.yml`文件,命名为`config.yml`,并填入正确的配置

6. 运行`npm run start`,脚本将会读取数据库并生成可导入 [Twikoo] 的数据文件。

生成的文件名为`comment.json`

7. 确认无误后,在腾讯云的 [云开发 数据库] 导入评论数据到`comment`集合中。
7. 确认无误后,在腾讯云的 [云开发 数据库] 备份并导入评论数据到`comment`集合。

## 特别鸣谢
感谢 [@大大的小蜗牛] 提供大量的测试数据,让工具更加完善。

[@Android]: https://android99.me
[Typecho]: http://typecho.org
[Twikoo]: https://twikoo.js.org
[MySQL]: https://www.mysql.com/cn/
Expand All @@ -35,3 +42,4 @@
[Git]: https://git-scm.com
[Node.js]: https://nodejs.org
[云开发 数据库]: https://console.cloud.tencent.com/tcb/db/
[@大大的小蜗牛]: https://eallion.com
4 changes: 2 additions & 2 deletions config.yml → config.example.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ salt: typecho

# 博主邮箱
# 用于确认博主身份
email: email@domain.com
email: email@example.com

# 站点地址
# 用于生成来源地址
site: https://domain.com
site: https://example.com

# 生成的文章链接格式
# 可用参数: {cid} 日志 ID, {slug} 日志缩略名, {category} 分类, {directory} 多级分类, {year} 年, {month} 月, {day} 日
Expand Down

0 comments on commit a207def

Please sign in to comment.