From 5787b8d1145a71fd61a260bf1d74d173aa2cd1f6 Mon Sep 17 00:00:00 2001 From: Elnu <9874955+ElnuDev@users.noreply.github.com> Date: Fri, 10 Jun 2022 18:18:10 -0700 Subject: [PATCH] Update README with parameter information --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9bcdbae..5c5e7f5 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,20 @@ # sakura-hugo-theme -A minimal blog theme for Hugo using [Sakura](https://github.com/oxalorg/sakura). + +A minimal blog theme for Hugo using [Sakura](https://github.com/oxalorg/sakura) that uses no custom CSS. + +For an example of this theme in action, check out [my blog](https://blog.elnu.com/) ([repository](https://github.com/ElnuDev/blog.elnu.com))! + +## Parameters + +This theme supports some basic configuration options in addition to support for [Matomo analytics](https://matomo.org/) a FOSS and self-hosted analytics solution. + +- `Theme`: Variant of Sakura to use. If unspecified, will default to `sakura.css`. e.g `Theme = 'dark'` will use `sakura-dark.css`. Available variant themes: + - `dark-solarized` + - `dark` + - `earthly` + - `ink` + - `pink` + - `vader` +- `HomepageHeader`: Text displayed at the absolute top of the homepage, hidden on pagination. Can include HTML markup. +- `MatomoURL`: URL of Matomo analytics server. +- `MatomoSiteId`: Site ID of Matomo. **Must be string.**