diff options
author | Jonathan Janssens <jonathan.janssens@gmail.com> | 2019-11-03 14:54:41 +0300 |
---|---|---|
committer | Jonathan Janssens <jonathan.janssens@gmail.com> | 2019-11-03 14:54:41 +0300 |
commit | 2d0e9fe7435c946eacb1e0af15c2bb97bc1064ee (patch) | |
tree | 5b04cb20763f42f17ffcca5712f4de958fd70ec0 | |
parent | 82dd2fa40faffabb72d42014c4e571ced6e96e0a (diff) |
add: feature_image to archetype / adding README
-rw-r--r-- | README.md | 25 | ||||
-rw-r--r-- | archetypes/default.md | 1 |
2 files changed, 26 insertions, 0 deletions
@@ -1,3 +1,7 @@ +## Demo + +A demo with feature images is available in the repository [jonathanjanssens/hugo-casper3-demo](https://github.com/jonathanjanssens/hugo-casper3-demo). + ## Installation ```$ mkdir themes @@ -5,8 +9,29 @@ $ cd themes $ git clone git@github.com:jonathanjanssens/hugo-casper3.git ``` +Either set the theme in your config to `casper3` or build with the `-t casper3` flag. + +## Using the theme + +This theme is very image heavy so it is recommended to set a `feature_image` parameter in the front matter of any content. + +Posts should be created under the 'post' content type, e.g. `hugo new post/example-post.md`. + +## Supported Hugo Versions + +The theme has been tested and is working with these versions of Hugo. It should work with others, but if you want to add another officially supported version give it a test and make a pull request to update this. + +- 0.55.5 + +## Development Roadmap + +[] Use SCSS from original theme instead of compiled CSS - also needs Hugo Pipes setting up +[] Multi author support and author taxonomy + ## Support +It would be nice if you leave the credit to me in the footer, unless you make a donation to show support. I can't really police this though, it's MIT licensed anyway so you can do whatever you want with the theme... + If you would like to show your appreciation to me for working on this theme you can <a href="https://paypal.me/JonathanJanssens">donate with Paypal</a> here. BTC: 1812FGaAJ19hokDoUFP6kK22dzT6zttkw5 diff --git a/archetypes/default.md b/archetypes/default.md index ac36e06..d9b7e82 100644 --- a/archetypes/default.md +++ b/archetypes/default.md @@ -1,2 +1,3 @@ +++ +feature_image = "" +++ |