summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authoramzrk22020-09-18 14:43:06 +0800
committeramzrk22020-09-18 14:43:06 +0800
commit163042c6bd0f40a26230916854a91df49d14ee33 (patch)
tree56dc6a09c3ba29d6ecd6d11f5d317b4a2d7035fb
parentc188eaf4bb3faeba20e53ad3eb0301fa8130476c (diff)
downloadhugo-theme-fuji-163042c6bd0f40a26230916854a91df49d14ee33.tar.gz
hugo-theme-fuji-163042c6bd0f40a26230916854a91df49d14ee33.tar.bz2
hugo-theme-fuji-163042c6bd0f40a26230916854a91df49d14ee33.zip
update: README
-rw-r--r--README.md43
-rw-r--r--README_CN.md45
2 files changed, 24 insertions, 64 deletions
diff --git a/README.md b/README.md
index cd088c8..2637f44 100644
--- a/README.md
+++ b/README.md
@@ -6,7 +6,9 @@ Fuji is a minimal Hugo theme with full dark mode support and GitHub Primer markd
[English](https://github.com/amzrk2/hugo-theme-fuji#readme) | [简体中文](https://github.com/amzrk2/hugo-theme-fuji/blob/master/README_CN.md)
-After the release of v2, **there may be major changes in the image lazyload shortcode** to make it easier to use. If you want to change the color scheme, please check [🔧 Advanced configuration](#-advanced-configuration).
+> Note that there will be major changes in the image lazyload shortcode, meaning that you can set **different aspect ratios** for images to generate lazyload placeholders. Once this feature is complete, this theme will enter the **maintenance stage**, and no new features will be added. Future support for the new Hugo version will still be available.
+
+> I am currently working on my new Hugo site with **a brand new theme**, and are planning to port the theme to a similar blog theme, you can preview it at <https://amzrk2.cc>. If you like this new theme, please give the [**theme repository**](https://github.com/amzrk2/amzrk2-ng) a star and I'll do my best to speed up the development process.
Supported languages: `cs`, `en`, `ja`, `nl`, `pt-pt`, `zh-hans`, `zh-hant`. Check the i18n folder to add more languages.
@@ -24,7 +26,7 @@ Supported languages: `cs`, `en`, `ja`, `nl`, `pt-pt`, `zh-hans`, `zh-hant`. Chec
- [📷 Image zoom and lazyload settings](#-image-zoom-and-lazyload-settings)
- [⚓ Markdown render hook](#-markdown-render-hook)
- [📨 Comments area](#-comments-area)
- - [🔧 Advanced configuration](#-advanced-configuration)
+ - [🔧 Custom stylesheet configuration](#-custom-stylesheet-configuration)
- [✏️ Issue und contributing](#%EF%B8%8F-issue-und-contributing)
- [📝 License](#-license)
- [🤝 Annotations](#-annotations)
@@ -149,6 +151,8 @@ Don't forget to add `math = true` in your front matter or `config.toml`.
### 📷 Image zoom and lazyload settings
+> Note that there will be major changes in the image lazyload shortcode, meaning that you can set **different aspect ratios** for images to generate lazyload placeholders. Once this feature is complete, this theme will enter the **maintenance stage**, and no new features will be added.
+
Zoomable, not lazyloaded:
```markdown
@@ -201,22 +205,17 @@ by default, disqus uses `{{ .Permalink }}` as `url`, `{{ .File.ContentBaseName }
Use the `[SITEROOT]/layouts/partials/comment-*.html` to cover `themes/fuji/layouts/partials/comment-*.html`. Then you can customize the url and identifier, or set multiple api key, add more settings for using DisqusJS. If you want to use DisqusJS, please remember to set `disqusJSApi` to anything in your `config.toml` to load CSS.
-### 🔧 Advanced configuration
-
-See [Report und contributing](#report-und-contributing).
+### 🔧 Custom stylesheet configuration
-If you just simply want to change the color scheme, set this in your `config.toml`:
+> Hugo extended version needed.
-```toml
-useHugoPipes = true
-```
+You can cover theme's internal SCSS variables with your own. Create `[SITEROOT]/assets/scss/_custom.scss` to cover variables in SCSS.
-This will make the theme use Hugo Pipes provided by Hugo Extended Vesion to compile the SCSS, then you can cover theme's internal SCSS with your own. Then create `[SITEROOT]/assets/scss/_custom.scss` cover variables in SCSS:
+Varibales available:
```scss
-$body-font: -apple-system, BlinkMacSystemFont, 'SF Pro Text', 'Helvetica Neue', 'Helvetica',
- 'Arial', 'PingFang SC', 'Hiragino Sans GB', 'Source Han Sans CN', 'Source Han Sans SC',
- 'Microsoft YaHei', 'WenQuanYi Micro Hei', sans-serif;
+$body-font: -apple-system, BlinkMacSystemFont, 'SF Pro Text', 'Helvetica Neue', 'Helvetica', 'Arial', 'PingFang SC',
+ 'Hiragino Sans GB', 'Source Han Sans CN', 'Source Han Sans SC', 'Microsoft YaHei', 'WenQuanYi Micro Hei', sans-serif;
$mono-font: 'Cascadia Code', 'SF Mono', 'Fira Code', 'Consolas', $body-font;
$title-font: 'Product Sans', $body-font;
$body-font-size: 16px;
@@ -244,24 +243,6 @@ $dark-color-codebg: #414449; // GitHub
Feel free to use the [issue tracker](https://github.com/amzrk2/hugo-theme-fuji/issues). The theme has only been fully tested on Firefox, so if there are some problems when accessing with Chrome or others please also report an issue.
-Inside the folder of theme root run:
-
-```bash
-npm install
-```
-
-Dev:
-
-```bash
-npm run serve
-```
-
-Build:
-
-```bash
-npm run build
-```
-
## 📝 License
The theme is released under the `Apache License 2.0`, for more information read the [License](https://github.com/amzrk2/hugo-theme-fuji/blob/master/LICENSE).
diff --git a/README_CN.md b/README_CN.md
index 8eef46c..c0bacfd 100644
--- a/README_CN.md
+++ b/README_CN.md
@@ -1,4 +1,4 @@
-# Fuji
+# 🍥 Fuji 🍥
简单的 Hugo 主题,支持夜间模式,Markdown 样式来自 GitHub Primer。
@@ -6,7 +6,9 @@
[English](https://github.com/amzrk2/hugo-theme-fuji#readme) | [简体中文](https://github.com/amzrk2/hugo-theme-fuji/blob/master/README_CN.md)
-**v2 发布之后关于 lazyload 这一块可能会有较大的改动**,现在这样确实有些麻烦了。如果想修改主题配色的话,可以参考 [🔧 其他高级修改](#-其他高级修改)。
+> 图片懒加载使用的 shortcode 近期将会大改,可以为懒加载的图片设置**不同的长宽比**,主题将会根据设置的属性生成对应的占位来防止页面跳动。这个功能完成之后主题将会进入维护阶段,将不会再添加新 feature,只进行对应 Hugo 版本更新的适配和维护。
+
+> 最近我正在为我的个人站点构建一个全新的 Hugo 主题,并且正在计划把新主题移植为通用的博客主题,你可以在 <https://amzrk2.cc> 预览新的主题。如果你喜欢这个主题的话,请给 [**新主题的 repo**](https://github.com/amzrk2/amzrk2-ng) 加颗星,我会尽力加快新主题的开发。
支持的 i18n 语言:`cs`, `en`, `ja`, `nl`, `pt-pt`, `zh-hans`, `zh-hant`。i18n 文件夹内为所有语言文件。
@@ -24,7 +26,7 @@
- [📷 图片放大的设置和 lazyload](#-图片放大的设置和-lazyload)
- [⚓ Markdown 钩子](#-markdown-钩子)
- [📨 评论区](#-评论区)
- - [🔧 其他高级修改](#-其他高级修改)
+ - [🔧 自定义 CSS](#-自定义-css)
- [👓 批判一番和贡献代码](#-批判一番和贡献代码)
- [📝 License](#-license)
- [🤝 Annotations](#-annotations)
@@ -147,6 +149,8 @@ Don't forget to add `math = true` in your front matter or `config.toml`.
### 📷 图片放大的设置和 lazyload
+> 图片懒加载使用的 shortcode 近期将会大改,可以为懒加载的图片设置**不同的长宽比**,主题将会根据设置的属性生成对应的占位来防止页面跳动。这个功能完成之后主题将会进入维护阶段,将不会再添加新 feature,只进行对应 Hugo 版本更新的适配和维护。
+
可放大,非 lazyload:
```markdown
@@ -199,22 +203,15 @@ Don't forget to add `math = true` in your front matter or `config.toml`.
使用 `[SITEROOT]/layouts/partials/comment-*.html` 来覆盖 `themes/fuji/layouts/partials/comment-*.html`。可在此文件内自定义指定的 url 和 identifier,或者为 DisqusJS 设置多个 api key 抑或是添加更多设置。注意如果使用 DisqusJS,将 `config.toml` 内的 `disqusJSApi` 解除注释来加载 CSS。
-### 🔧 其他高级修改
-
-见[批判一番和贡献代码](#批判一番和贡献代码)。
+### 🔧 自定义 CSS
-如果只是想修改主题色或者字体的话,在 `config.toml` 以下设置:
+> 需要 Hugo Extended Version。
-```toml
-useHugoPipes = true
-```
-
-这将让 Hugo 使用 Hugo Pipes 来编译 SCSS,注意需要 Extended Version,然后就可以自己覆盖主题内的 SCSS 变量了。创建 `[SITEROOT]/assets/scss/_custom.scss`,可选项如下:
+你可以自己覆盖主题内的 SCSS 变量。创建 `[SITEROOT]/assets/scss/_custom.scss`,可选项如下:
```scss
-$body-font: -apple-system, BlinkMacSystemFont, 'SF Pro Text', 'Helvetica Neue', 'Helvetica',
- 'Arial', 'PingFang SC', 'Hiragino Sans GB', 'Source Han Sans CN', 'Source Han Sans SC',
- 'Microsoft YaHei', 'WenQuanYi Micro Hei', sans-serif;
+$body-font: -apple-system, BlinkMacSystemFont, 'SF Pro Text', 'Helvetica Neue', 'Helvetica', 'Arial', 'PingFang SC',
+ 'Hiragino Sans GB', 'Source Han Sans CN', 'Source Han Sans SC', 'Microsoft YaHei', 'WenQuanYi Micro Hei', sans-serif;
$mono-font: 'Cascadia Code', 'SF Mono', 'Fira Code', 'Consolas', $body-font;
$title-font: 'Product Sans', $body-font;
$body-font-size: 16px;
@@ -242,24 +239,6 @@ $dark-color-codebg: #414449; // GitHub
[Issue](https://github.com/amzrk2/hugo-theme-fuji/issues)。主题本身只在 Firefox 上完整测试过,因此要是遇到了什么问题也可以随便批判。
-进入主题目录,运行:
-
-```bash
-npm install
-```
-
-开发用:
-
-```bash
-npm run serve
-```
-
-最终发布用:
-
-```bash
-npm run build
-```
-
## 📝 License
The theme is released under the `Apache License 2.0`, for more information read the [License](https://github.com/amzrk2/hugo-theme-fuji/blob/master/LICENSE).