Skip to content

docs: improve README #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
webbrain-one wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: improve README #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@


# planet-template-github

一个用于 [Planet](https://planet.cash/) 的 GitHub 风格模板。模板把 Planet 站点渲染成类似 GitHub Profile/Repository Overview 的页面：左侧是个人资料栏，右侧是 Overview、Pinned posts、年度贡献图和文章活动列表。
Expand Down Expand Up @@ -47,6 +49,7 @@ github/
```

其中 `generateArchive: true` 会生成 `archive.html`，也就是顶部 `Posts` 标签页指向的页面。
提示：`template.json` 中的 `buildNumber` 字段用于控制 Planet 的缓存。若修改模板后页面未显示更新，可尝试增加该值并重启 Planet 强制刷新缓存。

## 页面展示逻辑

Expand Down Expand Up @@ -172,4 +175,4 @@ article.pinned

## 鸣谢

本模板样式大多参考了[github-style](https://github.com/MeiK2333/github-style)，再次特别鸣谢！
本模板样式大多参考了[github-style](https://github.com/MeiK2333/github-style)，再次特别鸣谢！