diff --git a/CHANGELOG.md b/CHANGELOG.md index 5dc7723..1287d9c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,17 @@ All notable changes to this project will be documented in this file. +## [3.1.0] - 2024-01-20 + +### Add: + +- New shortcode: `quote` and `detail` + +### Fix: + +- Add `word-wrap: break-word` to inline code + + ## [3.0.0] - 2024-01-14 > **Warning** @@ -177,6 +188,7 @@ All notable changes to this project will be documented in this file. First release 🎉 +[3.1.0]: https://github.com/isunjn/serene/compare/v3.0.0...v3.1.0 [3.0.0]: https://github.com/isunjn/serene/compare/v2.3.0...v3.0.0 [2.3.0]: https://github.com/isunjn/serene/compare/v2.2.1...v2.3.0 [2.2.1]: https://github.com/isunjn/serene/compare/v2.2.0...v2.2.1 diff --git a/USAGE-zh_CN.md b/USAGE-zh_CN.md index 4bf8eaa..fd32b12 100644 --- a/USAGE-zh_CN.md +++ b/USAGE-zh_CN.md @@ -322,6 +322,23 @@ Hi, My name is .... {{ figure(src="/path/to/img", alt="some alt text", via="https://example.com") }} ``` +- 特殊引用,`cite` 可选: + + ```md + {% quote(cite="") %} + // content... + {% end %} + ``` + +- 可折叠 detail,`default_open` 可选: + + ```md + {% detail(title="", default_open=false) %} + // content... + {% end %} + ``` + + ### Callout - Serene 还使用 Shortcodes 实现了 Callout, 效果如示例站点的 [这个页面](https://serene-demo-site.vercel.app/blog/callouts) 所示,目前共有 6 种:`note` `important` `warning` `alert` `question` `tip`,格式如下,header 属性是可选的: diff --git a/USAGE.md b/USAGE.md index 5a38c50..5044475 100644 --- a/USAGE.md +++ b/USAGE.md @@ -320,6 +320,22 @@ 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 + {% quote(cite="") %} + // content... + {% end %} + ``` + +- Expandable detail, `default_open` is optional: + + ```md + {% detail(title="", default_open=false) %} + // content... + {% end %} + ``` ### Callout diff --git a/config.example.toml b/config.example.toml index 8c5c0a7..aa1f719 100644 --- a/config.example.toml +++ b/config.example.toml @@ -1,4 +1,4 @@ -# serene v3.0.0 +# serene v3.1.0 # # - docs: https://github.com/isunjn/serene/blob/latest/USAGE.md # - check for updates: https://github.com/isunjn/serene/releases