aditya/hugo-theme-even
1
0
Fork 0
mirror of https://git.adityakumar.xyz/hugo-theme-even.git synced 2024-11-08 22:49:44 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: init CHANGELOG, use errorf give friendlier error

Browse source 
This relates to #23
This commit is contained in:
olOwOlo 2018-02-01 21:46:27 +08:00
parent df28365582
commit b65b7ab2eb
No known key found for this signature in database
GPG key ID: 456394B6E7A15EA6
3 changed files with 31 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
CHANGELOG.md Normal file
View file

@ -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
```

1
exampleSite/config.toml
View file

@ -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 # 站点建立时间

3
layouts/_default/baseof.html
View file

@ -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 -}}
<!DOCTYPE html>
<html lang="{{ .Site.Language }}">
<head>