From 322c0727cf1fef93c1ae00e0bc9d73aa112c45df Mon Sep 17 00:00:00 2001 From: bake Date: Tue, 20 Aug 2019 13:54:03 +0200 Subject: Add paragraphs to the README --- README.md | 33 ++++++++++++++++++++++----------- 1 file changed, 22 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 18c903c..ca305df 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,37 @@ # Solar Theme for Hugo A minimalistic theme for [Hugo](https://gohugo.io/) blogs, fork of -[Solar Theme for Ghost](https://github.com/mattvh/solar-theme-ghost). +[Solar Theme for Ghost](https://github.com/mattvh/solar-theme-ghost). There is a +demo available on +[Hugos theme list](https://themes.gohugo.io/theme/solar-theme-hugo/). See the +[example config.toml](exampleSite/config.toml) for a starting point. -It offers three color schemes: (Solarized) `light`, (Solarized) `dark` (default) -and `gray`. Additional HTML can be injected just before `` and `` -by creating a `head.html` or `foot.html` inside `layouts/partials/`. The default -(empty) logo can be overwritten by creating a `logo.svg` in `static/img/`. +## Color schemes + +Solar offers three color schemes: (Solarized) `light`, (Solarized) `dark` +(default) and `gray`. ## Screenshot ![Screenshot](/images/tn.png) +## Additional HTML + +Custom HTML can be injected just before `` and `` by creating a +`head.html` or `foot.html` inside the sites `layouts/partials/` folder. The +default (empty) logo can be overwritten by creating a `logo.svg` in +`static/img/`. + ## Syntax Highlighting This theme does not bring a syntax highlighter. If you want to use -[Hugos](https://gohugo.io/content-management/syntax-highlighting/), remember to -update the color scheme by [setting pygmentsStyle](/exampleSite/config.toml#L4). -The pygments style `solarized-dark`, for example, matches the themes `dark` -color scheme, while `solarized-light` matches `light` and `solarized-dark256` -works with `gray`. Otherwise, the necessary JavaScript can be placed inside -`static/` and get included by providing a `footer.html` as described above. +[Hugos built in one](https://gohugo.io/content-management/syntax-highlighting/), +remember to update the color scheme by +[setting pygmentsStyle](/exampleSite/config.toml#L4). The pygments style +`solarized-dark`, for example, matches the themes `dark` color scheme, while +`solarized-light` matches `light` and `solarized-dark256` works well with +`gray`. Otherwise, the necessary JavaScript can be placed inside `static/` and +get included by providing a `footer.html` as described above. ## Installation -- cgit v1.2.3