Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/bul-ikana/hugo-cards.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHugo Aguirre <hugo.agmtz@gmail.com>2020-10-19 04:42:00 +0300
committerHugo Aguirre <hugo.agmtz@gmail.com>2020-10-19 04:42:00 +0300
commitaf8a0adc13a5a28055d74b39ac155b9bbe1fdcb5 (patch)
tree3b7ec7954a50797ebe8bd42373c5dbf2f030dad8
parent1837d73132c6df78cced695b9914e5e3e9c08eb0 (diff)
Update readme
-rw-r--r--README.md16
1 files changed, 11 insertions, 5 deletions
diff --git a/README.md b/README.md
index 176bf15..87cd681 100644
--- a/README.md
+++ b/README.md
@@ -10,6 +10,17 @@ Responsive theme built on bootstrap. Great for showcasing content with featured
Easily add disqus, google analytics, social links and a facebook like box.
+## Customization
+
+### Images
+To change the featured image of your post, you must provide a `img` param in your post front-matter. This theme now supports [page resources](https://gohugo.io/content-management/page-resources/) so your featured image should be in the same directory than your `index.md` post file.
+
+If you don't include one, a default image will be used. You can also customize this default image by changing the `defaultImage` param in your theme config. Be aware that this default image should be located on your `static/images` directory
+
+### CSS
+There is a `custom.css` file included where you can write and override any style you need. If you need additional files, you can add their relative links to the `custom_css` param in the theme config.
+
+
## Configuration
Please see the sample [`config.toml`](https://github.com/bul-ikana/hugo-cards/blob/master/exampleSite/config.toml).
@@ -52,8 +63,3 @@ The Google Analytics tracking ID
#### disqus
The disqus_thread ID
-
-### Customization
-
-#### CSS
-There is a `custom.css` file included where you can write and override any style you need. If you need additional files, you can add their relative links to the `custom_css` param in the theme config.