zhao/hugo-theme-moments
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

polish readme

Browse source
This commit is contained in:
FarseaSH 2024-01-14 17:33:12 +08:00
parent 9462ce49d8
commit 4133f2d5d5
1 changed files with 91 additions and 119 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

210
README.md
View file

@ -20,128 +20,113 @@ Check it out 👉 [Moments Demo](https://farseash.github.io/demo-hugo-theme-mome
## 特点 Feature
1. 专门支持短博文的Hugo主题
1. 专门支持短博文的 Hugo 主题
2. 响应式设计，桌面端&手机端精心适配
3. 拥有和社交平台一致的图片浏览体验
4. 简洁的设计，纯净的体验，摆脱社交平台广告
5. 支持在Moments中分享主流互联网平台的信息（朋友圈文章，知乎， 哔哩哔哩， 网易云音乐，等等）
6. 多用户，和不同的人一起搭建不同的Moments空间
7. (To be expected)RSS接入，第一时间了解朋友的分享
5. 支持在 Moments 中分享主流互联网平台的信息（朋友圈文章，知乎，哔哩哔哩， 网易云音乐，等等）
6. 设计上支持多用户，和不同的人一起搭建不同的 Moments 空间
## 快速入门
- [实例：各种类型的Moment](#实例：各种类型的Moment)
- [安装与部署](#安装与部署)
## 不同类型的 Moment 示例
### 实例：各种类型的Moment
### 附加图片的 Moment
#### 包含图片集的Moment
![图片集的moments](https://z3.ax1x.com/2021/10/24/5WpVWn.png)
```
<div style="display: flex; flex-wrap: wrap;">
<div style="min-width: 320px; max-width: 400px">
<img src="https://s11.ax1x.com/2024/01/11/pFCm8Et.png" alt="图片集的Moment" style="">
</div>
<div style="width: 450px">
<pre class="notranslate"><code style="text-wrap: nowrap">
---
name: 赛肯德
avatar: https://gimg2.baidu.com/image_search/src=http%3A%2F%2Fimg11.360buyimg.com%2Fn1%2Fjfs%2Ft22180%2F273%2F1048905858%2F16927%2Fc863f2d8%2F5b1ee306Nc3fa41e8.jpg&refer=http%3A%2F%2Fimg11.360buyimg.com&app=2002&size=f9999,10000&q=a80&n=0&g=0n&fmt=jpeg?sec=1630730078&t=818b15beaf41cabfa800ddea79f89445
date: 2021-08-04T11:57:49+08:00
name: Frank
signature: '@Moments 向导 002'
avatar: https://s11.ax1x.com/2024/01/07/pizHZLV.png
date: 2024-01-06T23:04:00+08:00
tags:
- 图片集
- 美食
- 美食
pictures:
- https://p8.itc.cn/images01/20210119/628400a0528c4dc696efdac8749b176d.jpeg
- https://img.uooyoo.com/img2017/5/9/2017050941664829.jpg
- https://cdn.pixabay.com/photo/2016/10/13/11/44/chocolates-1737503_1280.jpg
- https://cdn.pixabay.com/photo/2016/01/11/07/18/cupcakes-1133146_1280.jpg
note: 这是附带图片集的moment
- https://s11.ax1x.com/2024/01/07/pizO3tO.png
- https://s11.ax1x.com/2024/01/07/pizOBAf.png
- https://s11.ax1x.com/2024/01/07/pizOy9g.png
- https://s11.ax1x.com/2024/01/07/pizORun.png
- https://s11.ax1x.com/2024/01/07/pizOI4U.png
- https://s11.ax1x.com/2024/01/07/pizOTCF.png
- https://s11.ax1x.com/2024/01/07/pizjpd0.png
- https://s11.ax1x.com/2024/01/07/pizjiJU.png
- https://s11.ax1x.com/2024/01/07/pFSkNid.png
note:
---
你也可以为每条moment附带更多的图片，做成图片集。
好嘞～众所周知，美食能治愈一切！以下图片不建议睡前点开。
</code></pre>
</div>
</div>
比如最近打卡的美食们：
```
### 分享文章的 Moment
#### 单一图片的Moment
![单一图片的Moment](https://z3.ax1x.com/2021/10/24/5WptQx.png)
```
<div style="display: flex; flex-wrap: wrap;">
<div style="min-width: 320px; max-width: 400px">
<img src="https://s11.ax1x.com/2024/01/11/pFCmUgg.png" alt="分享链接Moment" style="">
</div>
<div style="width: 450px">
<pre class="notranslate"><code style="text-wrap: nowrap">
---
name: 福斯特
avatar: https://gimg2.baidu.com/image_search/src=http%3A%2F%2Fn.sinaimg.cn%2Fsinacn17%2F0%2Fw400h400%2F20181111%2F89f9-hnstwwq6307162.jpg&refer=http%3A%2F%2Fn.sinaimg.cn&app=2002&size=f9999,10000&q=a80&n=0&g=0n&fmt=jpeg?sec=1630729931&t=e8c4135ba966d5fbfd5d30adf96551c0
date: 2021-08-04T23:57:46+08:00
top: 7
name: Frank
signature: '@Moments 向导 002'
avatar: https://s11.ax1x.com/2024/01/07/pizHZLV.png
date: 2024-01-06T23:07:00+08:00
tags:
- 图片
- 最新moment
pictures:
- https://cdn.pixabay.com/photo/2016/03/09/11/57/grand-canyon-1246248_1280.jpg
note: 这是加入图片的moment
- 好文收藏
link: https://mp.weixin.qq.com/s/T2oxRagwfAAtHao5YqAY1A
link_text: 「好的友谊」的10点标志，你拥有过几点？
note:
---
你可以为每条moment附带图片。
比如说，好看的风景：
```
这篇公众号文章也挺不错的，推荐给大家。
</code></pre>
</div>
</div>
### 分享视频的 Moment
#### 附带网页链接的Moment
![网页链接](https://z3.ax1x.com/2021/10/24/5W3vfs.png)
```
<div style="display: flex; flex-wrap: wrap;">
<div style="min-width: 320px; max-width: 400px">
<img src="https://s11.ax1x.com/2024/01/14/pFPvjfI.png" alt="分享视频Moment" style="">
</div>
<div style="width: 450px">
<pre class="notranslate"><code style="text-wrap: nowrap">
---
name: 瑟德
avatar: https://gimg2.baidu.com/image_search/src=http%3A%2F%2Fimage.biaobaiju.com%2Fuploads%2F20190822%2F14%2F1566456820-UokjFbWpuN.jpg&refer=http%3A%2F%2Fimage.biaobaiju.com&app=2002&size=f9999,10000&q=a80&n=0&g=0n&fmt=jpeg?sec=1630729842&t=560fc243f983753c1f4541a1d9c0d365
date: 2021-08-03T11:57:40+08:00
name: Frank
signature: '@Moments 向导 002'
avatar: https://s11.ax1x.com/2024/01/07/pizHZLV.png
date: 2024-01-06T23:07:00+08:00
tags:
- 链接
- Github
- 不知道贴什么标签
link: https://www.github.com
link_logo:
link_text: GitHub - Where the world builds software · GitHub
note: 这是加入链接的Moment
- 好看的视频分享
link: //player.bilibili.com/player.html?aid=535243818&bvid=BV1cM41197ui&cid=1312553206&p=1
note:
---
你也可以像这样附带网络链接。
GitHub是通过Git进行版本控制的软件源代码托管服务平台，由GitHub公司（曾称Logical Awesome）的开发者Chris Wanstrath、P. J. Hyett和汤姆·普雷斯顿·沃纳使用Ruby on Rails编写而成。（引用自Wikipedia）
```
我是B站木鱼水心的粉丝，最近更新的史记系列超级好看。
</code></pre>
</div>
</div>
#### 纯文字Moment
## 更多正在设计开发中的 Moment 类型
![fNGzbF.png](https://z3.ax1x.com/2021/08/11/fNGzbF.png)
- 纪念日 / 倒数日
- 文字摘录引用
- 习惯打卡
- 歌词
- 地图格式
```
---
name:
avatar:
（如果您有任何其它想要添加的类型，欢迎在 [issue](https://github.com/FarseaSH/hugo-theme-moments/issues) 区域提出）
date: 2021-08-01T11:33:28+08:00
## 安装与部署
tags:
- default
-
note: 这是纯文字的moment
---
当然，你也可以什么都不附带，只发送纯文字moment。
```
### 安装与部署
#### 安装
### 安装
<!-- todo 要求 -->
@ -151,7 +136,7 @@ $ cd my_moments_name
$ git clone https://github.com/FarseaSH/hugo-theme-moments themes/moments
```
#### 第一次配置
### 第一次配置
将以下设置覆盖到`config.toml`文件中
@ -171,22 +156,8 @@ paginatePath = '.'
avatar = "/img/default_avatar.png"
```
#### 创建新的Moment
```
hugo new moments/your_moments_name.md
```
再进入`content/moments`文件夹打开相应的markdown文件进行编辑。
#### 将自己的Moments发布到网上
请参考Hugo文档deploy部分[Hugo Deploy | Hugo](https://gohugo.io/hosting-and-deployment/hugo-deploy/)
## 更多的设置
### 修改配置文件 `config.toml`
#### (Optional) config.toml 的配置
修改对应配置文件`config.toml`中的参数，以满足你的要求。对于下面没有提及的参数，请不要修改。
@ -198,18 +169,19 @@ hugo new moments/your_moments_name.md
- `name`: Moment默认发布人
- `avatar`: Moment默认发布人的头像
## 未来功能开发&愿景
### 创建新的Moment
- [ ] RSS订阅
- [ ] 将Moments打印，作为实体手帐
- [ ] Moments评论功能
- [ ] 更多平台，更多媒体类型的外链支持
```
hugo new your_moments_name.md
```
最后一段是我发布Moments demo时候写下的愿景，希望自己不忘初心，与Moments一起成长。
### 将自己的Moments发布到网上
请参考Hugo文档deploy部分[Hugo Deploy | Hugo](https://gohugo.io/hosting-and-deployment/hugo-deploy/)
> - Moments是一款Hugo主题，它为你提供了一个兼具社交性与私密性的记录分享空间。
> - 它可以是你的朋友圈，并利用RSS把你的moment推送给那些你想告诉的人
> - 它可以是你的私人手帐，将你的moment打印出来放进日记本的夹层里面
> - 它也可以是你的社交账号，附在博客旁，贴上那些短小精干的moment
> - 它还可以是你们的团队平台，和朋友、队友们一起创建属于你们的moments
## 更多正在开发的功能
- 更多 Moment 类型支持
- RSS 支持
- Moment 评论功能
- 卡片样式 Moments 主题开发