-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
13 changed files
with
412 additions
and
33 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,9 +1,101 @@ | ||
## hugo-theme-Reader | ||
<p align="center"> | ||
<a href="https://github.com/lovezsh/hugo-theme-Reader/"> | ||
<img src="images/logo.png" alt="Logo" width="300"> | ||
</a> | ||
<p align="center"> | ||
一款简单的、易于阅读的 hugo 主题,集成了多种功能。 | ||
<br /> | ||
<a href="https://github.com/lovezsh/hugo-theme-Reader"><strong>探索本项目的文档 »</strong></a> | ||
<br /> | ||
<br /> | ||
<a href="https://zburu.com" target="_blank">查看Demo</a> | ||
· | ||
<a href="https://github.com/lovezsh/hugo-theme-Reader/issues">报告Bug</a> | ||
· | ||
<a href="https://github.com/lovezsh/hugo-theme-Reader/issues">提出新特性</a> | ||
</p> | ||
|
||
小清新主题 | ||
</p> | ||
|
||
 | ||
本篇 README.md 面向主题使用者和开发者,欢迎使用和提交 pr. | ||
|
||
 | ||
|
||
 | ||
新增: | ||
- [x] 图片灯箱 | ||
- [x] 文章目录 | ||
- [x] 文章搜索 | ||
|
||
### 目录 | ||
|
||
- [目录](#目录) | ||
- [上手指南](#上手指南) | ||
- [文件目录说明](#文件目录说明) | ||
- [配置](#配置) | ||
- [贡献者](#贡献者) | ||
- [如何参与本项目](#如何参与本项目) | ||
- [作者](#作者) | ||
- [版权说明](#版权说明) | ||
|
||
### 上手指南 | ||
|
||
```shell | ||
git clone git@github.com:lovezsh/hugo-theme-Reader.git themes/Reader | ||
``` | ||
|
||
修改 `config.toml`: | ||
|
||
``` | ||
theme = "Reader" | ||
``` | ||
|
||
注意:`/content` 文件夹下文章文件夹名要改成 `/blog`,不然会出现不可预知的错误。详情看 `/exampleSite` 示例。 | ||
|
||
### 文件目录说明 | ||
eg: | ||
|
||
```shell | ||
+---archetypes | ||
+---exampleSite | ||
| +---content | ||
| +---layouts | ||
| \---static | ||
+---layouts | ||
| +---partials | ||
| \---_default | ||
\---static | ||
+---css | ||
+---fonts | ||
+---images | ||
+---js | ||
``` | ||
|
||
### 配置 | ||
|
||
1. 第三方评论使用 artalk. | ||
|
||
3. `config.toml` 完整配置文件 | ||
|
||
[config.toml](./exampleSite/config.toml) | ||
|
||
|
||
### 贡献者 | ||
|
||
请阅读**CONTRIBUTING.md** 查阅为该项目做出贡献的开发者。 | ||
|
||
#### 如何参与本项目 | ||
|
||
贡献使开源社区成为一个学习、激励和创造的绝佳场所。你所作的任何贡献都是**非常感谢**的。 | ||
|
||
fork 仓库,本地开发完成提交仓库,在提交 pr 时注明修改的功能等,保证在没有 bug 的前提下提交,我会进行 review code. | ||
|
||
|
||
### 作者 | ||
|
||
子舒(shuxhan@163.com) | ||
|
||
*您也可以在贡献者名单中参看所有参与该项目的开发者。* | ||
|
||
### 版权说明 | ||
|
||
该项目签署了MIT 授权许可,详情请参阅 [LICENSE](https://github.com/lovezsh/hugo-theme-Reader/blob/main/LICENSE) | ||
|
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
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
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 |
---|---|---|
@@ -0,0 +1,5 @@ | ||
{{- $.Scratch.Set "posts" slice -}} | ||
{{- range where .Site.RegularPages "Type" "blog" -}} | ||
{{- $.Scratch.Add "posts" (dict "title" .Title "permalink" .Permalink) -}} | ||
{{- end -}} | ||
{{- $.Scratch.Get "posts" | jsonify -}} |
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,13 +1,13 @@ | ||
<div id="Artalk"></div> | ||
<link href="" rel="stylesheet"> | ||
<link href="https://artalk.zburu.com/dist/Artalk.css" rel="stylesheet"> | ||
<link rel="stylesheet" href="{{ .Site.Params.staticPrefix }}{{ "css/artalk.css" | relURL }}"> | ||
<script src=""></script> | ||
<script src="https://artalk.zburu.com/dist/Artalk.js"></script> | ||
<script> | ||
new Artalk({ | ||
el: '#Artalk', | ||
pageKey: '', | ||
pageTitle: '', | ||
server: '', | ||
site: '', | ||
server: 'https://artalk.zburu.com', | ||
site: '子舒的博客', | ||
}) | ||
</script> |
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
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,2 +1,3 @@ | ||
<script src="{{ .Site.Params.staticPrefix }}{{ "js/simplebox.min.js" | relURL }}"></script> | ||
<script src="{{ .Site.Params.staticPrefix }}{{ "js/main.js" | relURL }}"></script> | ||
<script src="{{ .Site.Params.staticPrefix }}{{ "js/main.js" | relURL }}"></script> | ||
<script src="{{ .Site.Params.staticPrefix }}{{ "js/search.js" | relURL }}"></script> |
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
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
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
Oops, something went wrong.