diff options
| author | Yauhen Shulitski <jsnjack@gmail.com> | 2018-09-02 22:33:48 +0300 |
|---|---|---|
| committer | Yauhen Shulitski <jsnjack@gmail.com> | 2018-09-02 22:33:48 +0300 |
| commit | 823adb3e7f6415fd9a34e43fd4b0532b4bcc2ca4 (patch) | |
| tree | 69a75317975b15ebad1ea2824d7e568383090e65 | |
| parent | 61bb4dd728ecf761600d33ba13f87eef3079d095 (diff) | |
Update readme
| -rw-r--r-- | README.md | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..98f33f7 --- /dev/null +++ b/README.md @@ -0,0 +1,16 @@ +Hugo Changelog Theme +===== + +A [Hugo](https://gohugo.io/) theme to display changelog + +# Features + - Build with [Spectre.css](https://picturepan2.github.io/spectre/) (All unused components are disabled) + - Pagination + - Mobile friendly + +# Conventions + - Create non-released entries in `experimental` folder. All of them are displayed in the top of the first page + - Create released entries in `released` folders. Entries are sorted by Weight. Weight is displayed as version + +# Shortcodes + - `{{% tag fixed %}}` - create a specific tag before entry text. Available tag types are: added, changed, fixed, deprecated, removed, security |