diff --git a/README.md b/README.md index 3d067c0..ae333e9 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,58 @@ # Sky +![screenshot.png](./screenshot.png) + > 敬我们对生活的热爱。 -Sky 是一个简洁的 Typecho 主题,基于 Argon 框架。 +Sky 是一个简洁的单栏响应式 Typecho 主题。 -demo:[skywt.cn](https://skywt.cn/) +Demo:[skywt.cn](https://skywt.cn/) -## 特色 / Features +## 使用 / Usage -- 响应式布局 -- 集成了 [WordsCounter 全站字数统计插件](https://github.com/elatisy/Typecho_WordsCounter) +前往 Releases 下载源代码压缩包,解压后将文件夹重命名为 sky 并移动到 Typecho 主题目录,在 Typecho 启用主题后在主题设置中进行设置即可。 + +建议在「Typecho 后台设置 - 阅读 - 站点首页」中选择「直接调用 homepage.php 模板文件」,体验一个简洁的全屏首页。 + +集成了 highlight.js,不建议使用其他代码高亮的插件。 + +### 关于字段(themeFields) + +- 文章头图地址:填入一个图片 URL 地址, 就可以让文章加上头图。 +- 页面 icon:为页面填入一个 fontawesome icon 代码,在菜单栏链接前会显示 icon。对文章无效。Fontawesome 是 5.15 版本,参见:[Fontawesome Icons](https://fontawesome.com/v5.15/icons)。举例:填入 `fa fa-coffee` 则会显示咖啡杯图标。 +- 重定向至:输入一个 URL,打开页面时会自动重定向到这个 URL,用于定制菜单栏。对文章无效。 ## 说明 / Instructions +### 引用的库和资源 + +- [Argon Design System](https://demos.creative-tim.com/argon-design-system/index.html) + - jQuery + - Bootstrap 4 + - Popper.js +- Fontawesome (via Staticfile) +- highlight.js (via jsDelivr) +- [lately.js](https://github.com/Tokinx/lately) +- Google Fonts + +### 关于浏览器支持 + 不支持 IE 等上古浏览器。 -由于使用了 `sticky-top` 等较为先进的特性,可能也不能很好地支持部分国产魔改内核浏览器(如某度浏览器)。请尽量使用较新的主流浏览器访问以获得最佳体验。 +由于使用了 `sticky-top` 等较为先进的特性,可能也不能很好地支持部分国产魔改内核浏览器(如某度浏览器)或者主流浏览器的落后版本。请尽量使用较新的主流浏览器访问以获得最佳体验。 -内置了 Highlight.js +## 许可 / License -推荐的插件: \ No newline at end of file +GNU GENERAL PUBLIC LICENSE + +## 待咕 / To-do + +- [ ] 搜索功能 +- [ ] 夜间模式 +- [ ] 文章头图 +- [ ] 主题更新检测 + +## 更新记录 / Changelog + +### 1.0 + +- 第一个能用的正式版本! \ No newline at end of file diff --git a/screenshot.png b/screenshot.png index 8aa2987..e138cea 100644 Binary files a/screenshot.png and b/screenshot.png differ