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

update readme

Browse source
This commit is contained in:
Mivinci 2022-11-09 00:05:50 +08:00
parent 3da0bb149b
commit 3b6079c2a5
1 changed files with 24 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

43
README.md
View file

@ -1,11 +1,12 @@
# Minima
A clean and minimal Hugo theme porting from [Hexo Minima](https://github.com/adisaktijrs/hexo-theme-minima). See the [demo site](https://mivinci.github.io/hugo-theme-minima).
> The main branch is in development stage, UI or configuration may vary.
A clean and minimal Hugo theme porting from [Hexo Minima](https://github.com/adisaktijrs/hexo-theme-minima). Check out the [example site](https://mivinci.github.io/hugo-theme-minima).
![screenshot](./images/tn.png)
> Note that the main branch is in development stage, UI or configuration may vary.
## Features
- [x] Dark mode
@ -43,27 +44,31 @@ git clone https://github.com/mivinci/hugo-theme-minima.git themes/minima
Follow [exampleSite/config.toml](https://github.com/Mivinci/hugo-theme-minima/blob/main/exampleSite/config.toml) and edit your own one.
### Supported Front Matters
## Supported Front Matters
| Field | Type | Explanation |
|:----------- |:------ |:------------------------------------------------------ |
| title | string | Title of the post |
| description | string | Description of the post |
| date | string | Datetime when the post is written |
| link | string | If set, the post will redirect to an external link |
| categories | array | Array of categories the posts belongs to |
| series | array | Array of series the post belongs to |
| tags | array | Array of tags the posts is related to |
| math | bool | True if the post needs to render math formulas |
| mermaid | bool | True if the post needs to render mermaid diagrams |
| comment | bool | True if the post allows people to make comments |
| draft | bool | True if the post isn't already for publishing |
| Attr | Type | Explanation |
|:----------- |:------ |:------------|
| title | string | title |
| description | string | description |
| date | string | creation time |
| categories | array | category list |
| series | array | series list |
| tags | array | tag list |
| math | bool | enables math formulas rendering |
| mermaid | bool | enables flowcharts rendering |
| comment | bool | enable comment plugin |
| draft | bool | disallow being published |
| link | string | a URL to redirect to |
### Contribution
## Contribution
I'm currently looking for i18n contributors :)
### Feedback
## Feedback
Feedbacks are welcome [here](https://github.com/Mivinci/hugo-theme-minima/issues).
## License
Hugo Minima is MIT licensed.