generated from halo-dev/plugin-starter
-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
更新 README,添加预览图。 /kind documentation ```release-note None ```
- Loading branch information
Showing
3 changed files
with
83 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,10 @@ | ||
# plugin-migrate | ||
|
||
支持多种平台的数据迁移,目前已支持: | ||
支持从其他平台迁移数据到 Halo 的插件。 | ||
|
||
![Screenshot](./docs/img/screenshot.png) | ||
|
||
目前已支持以下平台: | ||
|
||
1. Halo 1.5 / 1.6 | ||
2. [WordPress](https://wordpress.org/) | ||
|
@@ -21,6 +25,17 @@ | |
## 开发环境 | ||
|
||
插件开发的详细文档请查阅:<https://docs.halo.run/developer-guide/plugin/introduction> | ||
|
||
所需环境: | ||
|
||
1. Java 17 | ||
2. Node 18 | ||
3. pnpm 8 | ||
4. Docker (可选) | ||
|
||
克隆项目: | ||
|
||
```bash | ||
git clone [email protected]:halo-sigs/plugin-migrate.git | ||
|
||
|
@@ -33,6 +48,10 @@ git clone [email protected]:{your_github_id}/plugin-migrate.git | |
cd path/to/plugin-migrate | ||
``` | ||
|
||
### 运行方式 1(推荐) | ||
|
||
> 此方式需要本地安装 Docker | ||
```bash | ||
# macOS / Linux | ||
./gradlew pnpmInstall | ||
|
@@ -41,6 +60,22 @@ cd path/to/plugin-migrate | |
./gradlew.bat pnpmInstall | ||
``` | ||
|
||
```bash | ||
# macOS / Linux | ||
./gradlew haloServer | ||
|
||
# Windows | ||
./gradlew.bat haloServer | ||
``` | ||
|
||
执行此命令后,会自动创建一个 Halo 的 Docker 容器并加载当前的插件,更多文档可查阅:<https://docs.halo.run/developer-guide/plugin/basics/devtools> | ||
|
||
### 运行方式 2 | ||
|
||
> 此方式需要使用源码运行 Halo | ||
编译插件: | ||
|
||
```bash | ||
# macOS / Linux | ||
./gradlew build | ||
|
@@ -55,11 +90,8 @@ cd path/to/plugin-migrate | |
halo: | ||
plugin: | ||
runtime-mode: development | ||
classes-directories: | ||
- "build/classes" | ||
- "build/resources" | ||
lib-directories: | ||
- "libs" | ||
fixedPluginPath: | ||
- "/path/to/plugin-migrate" | ||
``` | ||
最后重启 Halo 项目即可。 |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,23 +1,41 @@ | ||
# plugin-migrate | ||
|
||
支持多种平台的数据迁移,目前已支持: | ||
支持从其他平台迁移数据到 Halo 的插件。 | ||
|
||
![Screenshot](/img/screenshot.png) | ||
|
||
目前已支持以下平台: | ||
|
||
1. Halo 1.5 / 1.6 | ||
2. WordPress | ||
2. [WordPress](https://wordpress.org/) | ||
3. RSS / Atom 订阅链接 | ||
4. HUGO | ||
5. Ghost | ||
4. [Hugo](https://gohugo.io/) | ||
5. [Ghost](https://ghost.org/) | ||
|
||
## 使用方式 | ||
|
||
1. 下载,目前提供以下两个下载方式: | ||
- GitHub Releases:访问 [Releases](https://github.com/halo-sigs/plugin-migrate/releases) 下载 Assets 中的 JAR 文件。 | ||
- Halo 应用市场:<https://halo.run/store/apps/app-TlUBt> | ||
2. 安装,插件安装和更新方式可参考:<https://docs.halo.run/user-guide/plugins> | ||
3. 启动插件之后,即可在 Console 的左侧菜单栏看到**迁移**的菜单。 | ||
3. 启动插件之后,即可在 Console 的左侧菜单栏看到 **迁移** 的菜单。 | ||
|
||
> **Warning** | ||
> 详细的迁移文档请查阅 <https://halo-plugin-migrate.pages.dev> | ||
## 开发环境 | ||
|
||
插件开发的详细文档请查阅:<https://docs.halo.run/developer-guide/plugin/introduction> | ||
|
||
所需环境: | ||
|
||
1. Java 17 | ||
2. Node 18 | ||
3. pnpm 8 | ||
4. Docker (可选) | ||
|
||
克隆项目: | ||
|
||
```bash | ||
git clone [email protected]:halo-sigs/plugin-migrate.git | ||
|
||
|
@@ -30,6 +48,10 @@ git clone [email protected]:{your_github_id}/plugin-migrate.git | |
cd path/to/plugin-migrate | ||
``` | ||
|
||
### 运行方式 1(推荐) | ||
|
||
> 此方式需要本地安装 Docker | ||
```bash | ||
# macOS / Linux | ||
./gradlew pnpmInstall | ||
|
@@ -38,6 +60,22 @@ cd path/to/plugin-migrate | |
./gradlew.bat pnpmInstall | ||
``` | ||
|
||
```bash | ||
# macOS / Linux | ||
./gradlew haloServer | ||
|
||
# Windows | ||
./gradlew.bat haloServer | ||
``` | ||
|
||
执行此命令后,会自动创建一个 Halo 的 Docker 容器并加载当前的插件,更多文档可查阅:<https://docs.halo.run/developer-guide/plugin/basics/devtools> | ||
|
||
### 运行方式 2 | ||
|
||
> 此方式需要使用源码运行 Halo | ||
编译插件: | ||
|
||
```bash | ||
# macOS / Linux | ||
./gradlew build | ||
|
@@ -52,11 +90,8 @@ cd path/to/plugin-migrate | |
halo: | ||
plugin: | ||
runtime-mode: development | ||
classes-directories: | ||
- "build/classes" | ||
- "build/resources" | ||
lib-directories: | ||
- "libs" | ||
fixedPluginPath: | ||
- "/path/to/plugin-migrate" | ||
``` | ||
最后重启 Halo 项目即可。 |