From b65b7ab2eb63217f143754c376a7cbcfb59c6e82 Mon Sep 17 00:00:00 2001 From: olOwOlo <26087907+olOwOlo@users.noreply.github.com> Date: Thu, 1 Feb 2018 21:46:27 +0800 Subject: [PATCH] docs: init CHANGELOG, use `errorf` give friendlier error This relates to #23 --- CHANGELOG.md | 27 +++++++++++++++++++++++++++ exampleSite/config.toml | 1 + layouts/_default/baseof.html | 3 +++ 3 files changed, 31 insertions(+) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..dad3186 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,27 @@ +# Changelog + +## 3.0.0 + +- feat: add `center`, `right`, `left` shortcodes +- feat: support 'right' and 'left' class value for the built-in `figure` + +### Breaking changes + +- See [Language Support](https://github.com/olOwOlo/hugo-theme-even#language-support). +- See [Favicon](https://github.com/olOwOlo/hugo-theme-even#favicon). +- Remove deprecated `bootcdn` param, you can use `[params.publicCDN]`. +- The `archive-paginate` param rename to `archivePaginate`. +- Add a `postMetaInFooter` parameter to control the `contentCopyright` container, and now you can show the author and lastMod information without displaying the license. +- There must be a `version` param, otherwise the build process will give an error. +- Minimum version required: 0.26 -> 0.35 + +```toml +# add +version = "3.x" # Used to give a friendly message when you have an incompatible update + +# add +postMetaInFooter = true + +# rename archive-paginate +archivePaginate = 50 +``` diff --git a/exampleSite/config.toml b/exampleSite/config.toml index 927761a..8350b64 100644 --- a/exampleSite/config.toml +++ b/exampleSite/config.toml @@ -42,6 +42,7 @@ copyright = "" # default: author.name ↓ # 默认为下面配 url = "/categories/" [params] + version = "3.x" # Used to give a friendly message when you have an incompatible update debug = false # If true, load `eruda.min.js`. See https://github.com/liriliri/eruda since = "2017" # Site creation time # 站点建立时间 diff --git a/layouts/_default/baseof.html b/layouts/_default/baseof.html index 445c5fb..ce87827 100644 --- a/layouts/_default/baseof.html +++ b/layouts/_default/baseof.html @@ -1,3 +1,6 @@ +{{ if ne .Site.Params.version "3.x" -}} +{{ errorf "\n\nThere are two possible situations that led to this error:\n 1. You haven't copied the config.toml yet. See https://github.com/olOwOlo/hugo-theme-even#installation \n 2. You have an incompatible update. See https://github.com/olOwOlo/hugo-theme-even/blob/master/CHANGELOG.md#300 \n\n有两种可能的情况会导致这个错误发生:\n 1. 你还没有复制 config.toml 参考 https://github.com/olOwOlo/hugo-theme-even/blob/master/README-zh.md#installation \n 2. 你进行了一次不兼容的更新 参考 https://github.com/olOwOlo/hugo-theme-even/blob/master/CHANGELOG.md#300 \n" -}} +{{ end -}}