Skip to content

Commit 35ad4d4

Browse files
authored
docs: refine readme (#4)
1 parent 8a0c776 commit 35ad4d4

File tree

1 file changed

+51
-2
lines changed

1 file changed

+51
-2
lines changed

README.md

Lines changed: 51 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,54 @@
11
# plugin-sitemap
22

3-
Halo 2.0 的站点 Sitemap 链接生成插件(WIP)
3+
Halo 2.0 的站点 Sitemap 链接生成插件
44

5-
安装插件之后会提供一个 `http://your-host/sitemap.xml` 的链接作为站点的 Sitemap。
5+
## 开发环境
6+
7+
```bash
8+
git clone git@github.com:halo-sigs/plugin-sitemap.git
9+
10+
# 或者当你 fork 之后
11+
12+
git clone git@github.com:{your_github_id}/plugin-sitemap.git
13+
```
14+
15+
```bash
16+
cd path/to/plugin-sitemap
17+
```
18+
19+
```bash
20+
# macOS / Linux
21+
./gradlew pnpmInstall
22+
23+
# Windows
24+
./gradlew.bat pnpmInstall
25+
```
26+
27+
```bash
28+
# macOS / Linux
29+
./gradlew build
30+
31+
# Windows
32+
./gradlew.bat build
33+
```
34+
35+
修改 Halo 配置文件:
36+
37+
```yaml
38+
halo:
39+
plugin:
40+
runtime-mode: development
41+
classes-directories:
42+
- "build/classes"
43+
- "build/resources"
44+
lib-directories:
45+
- "libs"
46+
fixedPluginPath:
47+
- "/path/to/plugin-sitemap"
48+
```
49+
50+
## 使用方式
51+
52+
1. 在 [Releases](https://github.com/halo-sigs/plugin-sitemap/releases) 下载最新的 JAR 文件。
53+
2. 在 Halo 后台的插件管理上传 JAR 文件进行安装。
54+
3. 启动插件之后,即可通过 `https://your-host/sitemap.xml` 来访问站点地图。

0 commit comments

Comments
 (0)