Skip to content

Commit

Permalink
docs: update demo site link
Browse files Browse the repository at this point in the history
  • Loading branch information
isunjn committed Jan 31, 2024
1 parent 0f612f8 commit e1607ab
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 15 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,17 @@
<img width="1501" alt="screenshot" src="https://github.com/isunjn/serene/assets/60461730/61b9ff3d-6ed3-4062-8872-1f3a3d9b60a7">

<br />
<br />

A well-crafted blog theme for [zola](https://www.getzola.org)
A blog theme for [zola](https://www.getzola.org), simple and clean

## Demo

- <https://serene-demo-site.vercel.app>
- <https://serene-demo.pages.dev>

## Features

- A spiffy design, simple and clean
- A spiffy design, well crafted
- Projects page
- Dark mode
- Image zooming
Expand Down
8 changes: 4 additions & 4 deletions USAGE-zh_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ Hi, My name is ....

### 字体

- <del>Serene 默认使用 [Google Fonts](https://fonts.google.com/) 的 Signika 字体,</del>如需自定义字体,新建 `myblog/templates/_custom_font.html` 并将从 Google Fonts 复制的字体样式表 link 标签放入其中,然后修改 `myblog/sass/main.scss` 中的 `--main-font` 或者 `--code-font`.
- <del>Serene 默认使用 [Google Fonts](https://fonts.google.com/) 的 Signika 字体,</del>如需自定义字体,新建 `myblog/templates/_custom_font.html` 并将从 Google Fonts 复制的字体样式表 link 标签放入其中,然后修改 `myblog/sass/main.scss` 中的 `--main-font` 或者 `--code-font`.

- 为了进一步提高网站速度, 你也可以选择自己托管字体文件(可选):
1. 打开 [google-webfonts-helper](https://gwfh.mranftl.com) 并选择一个字体
Expand Down Expand Up @@ -261,11 +261,11 @@ Hi, My name is ....
title = ""
date = 2022-01-01
draft = true

[taxonomies]
categories = ["one"]
tags = ["one", "two", "three"]

[extra]
lang = "en"
toc = true
Expand Down Expand Up @@ -341,7 +341,7 @@ Hi, My name is ....

### Callout

- Serene 还使用 Shortcodes 实现了 Callout, 效果如示例站点的 [这个页面](https://serene-demo-site.vercel.app/blog/callouts) 所示,目前共有 6 种:`note` `important` `warning` `alert` `question` `tip`,格式如下,header 属性是可选的:
- Serene 还使用 Shortcodes 实现了 Callout, 效果如示例站点的 [这个页面](https://serene-demo.pages.dev/blog/callouts) 所示,目前共有 6 种:`note` `important` `warning` `alert` `question` `tip`,格式如下,header 属性是可选的:

```md
{% note(header="Note") %}
Expand Down
14 changes: 7 additions & 7 deletions USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,9 +227,9 @@ Now the myblog directory may looks like this:

### Fonts

- <del>Serene uses the Signika font of [Google Fonts](https://fonts.google.com/) by default.</del> If you want a different font, create a new `myblog/templates/_custom_font.html` and put the font link tags you copied from google fonts website into it, and then modify `--main-font` or `--code-font` in `myblog/sass/main.scss`.
- <del>Serene uses the Signika font of [Google Fonts](https://fonts.google.com/) by default.</del> If you want a different font, create a new `myblog/templates/_custom_font.html` and put the font link tags you copied from google fonts website into it, and then modify `--main-font` or `--code-font` in `myblog/sass/main.scss`.

- For performance reason, you may want to self-host font files (optional):
- For performance reason, you may want to self-host font files (optional):
1. Open [google-webfonts-helper](https://gwfh.mranftl.com) and choose your font
2. Modify `Customize folder prefix` of step 3 to `/font/` and then copy the css
3. Replace the content of `myblog/templates/_custom_font.html` with a `<style> </style>` tag, with the css you just copied in it.
Expand Down Expand Up @@ -261,11 +261,11 @@ Now the myblog directory may looks like this:
title = ""
date = 2022-01-01
draft = true

[taxonomies]
categories = ["one"]
tags = ["one", "two", "three"]

[extra]
lang = "en"
toc = true
Expand All @@ -289,7 +289,7 @@ Now the myblog directory may looks like this:

- You can add a `<!-- more -->` line, the content before it will become the summary/description of the post. You can set `truncate_summary = true` to remove the summary from the post webpage.

- A post marked `featured = true` will display a `*` mark in front of it in list, you can use this to mark a post as "most worthy to read"
- A post marked `featured = true` will display a `*` mark in front of it in list, you can use this to mark a post as "most worthy to read"

- If you set `blog_categorized = true`, posts will be sorted alphabetically by default, you can manually set the order by adding the prefix of `__[0-9]{2}__` in front of the category name, for example, `categories = ["__01__Balabala"]`

Expand Down Expand Up @@ -320,7 +320,7 @@ Now the myblog directory may looks like this:
```md
{{ figure(src="/path/to/img", alt="some alt text", via="https://example.com") }}
```

- Special quote, `cite` is optional:

```md
Expand All @@ -339,7 +339,7 @@ Now the myblog directory may looks like this:

### Callout

- Serene also uses shortcodes to implement callouts, the effect is shown in [this page](https://serene-demo-site.vercel.app/blog/callouts) of the demo site, there are currently 6 types: `note` `important ` `warning` `alert` `question` `tip`, the format is as follows, the header attribute is optional:
- Serene also uses shortcodes to implement callouts, the effect is shown in [this page](https://serene-demo.pages.dev/blog/callouts) of the demo site, there are currently 6 types: `note` `important ` `warning` `alert` `question` `tip`, the format is as follows, the header attribute is optional:

```md
{% note(header="Note") %}
Expand Down
2 changes: 1 addition & 1 deletion theme.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ description = "A blog theme for zola, simple and clean"
license = "MIT"
homepage = "https://github.com/isunjn/serene"
min_version = "0.9.0"
demo = "https://serene-demo-site.vercel.app"
demo = "https://serene-demo.pages.dev"

[author]
name = "isunjn"
Expand Down

0 comments on commit e1607ab

Please sign in to comment.