From 1cb01a90eefb59d6db2dfe49a20fcf8060425c24 Mon Sep 17 00:00:00 2001 From: Andrew Sail Date: Wed, 19 May 2021 23:10:39 -0400 Subject: clarify background/icon usage in README, css to remove dotted line from logo --- README.md | 40 ++++++++++++++++++++++++++++++++++++++++ static/assets/css/main.css | 6 +++++- 2 files changed, 45 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7d13a74..5d6be12 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,7 @@ A hugo port of HTML5UP's responsive and minimal dimension theme. With native sup - [How to start](#how-to-start) - [How to configure](#how-to-configure) - [Post archetype](#post-archetype) + - [`background` and `logo` Params](#background-and-logo-params) - [How to run your site](#how-to-run-your-site) - [How to contribute](#how-to-contribute) - [Sponsoring](#sponsoring) @@ -57,6 +58,45 @@ background: "" logo: "" ``` +### `background` and `logo` Params + +As indicated above, `background` and `image` can be a jpg of your choice by placing JPGs, PNGs, SVGs, etc. in the `static` directory of your repository. If the `static` directory does not yet exist, create it. + +With the following repo structure: +``` + . + ├── config.toml + ├── content + │ ├── posts + │ │ └── _index.md + │ ├── _index.md + │ └── elements.md + ├── static + │ └── images + │ └── custom_bg.jpg + └── archetypes + └── default.md +``` + +`static/images/custom_bg.jpg` can be referenced in `content/_index.md` as: +```yaml + --- + title: Your Name + description: A great human + background: "images/custom_bg.jpg" + --- +``` + +...or in `content/posts/_index.md` as: +```yaml + --- + title: Posts + description: A great human's posts + background: "../images/custom_bg.jpg" + --- +``` + +Follow the same conventions as above for `logo`. **Alternatively**, both `background` and `logo` can be URLs to online resources. ## How to run your site From your Hugo root directory run: diff --git a/static/assets/css/main.css b/static/assets/css/main.css index c670056..68d569b 100644 --- a/static/assets/css/main.css +++ b/static/assets/css/main.css @@ -157,6 +157,10 @@ input, select, textarea { color: inherit; } + .logo a { + border-bottom: unset; + } + a:hover { border-bottom-color: transparent; } @@ -1667,4 +1671,4 @@ input, select, textarea { body.is-preload #footer { opacity: 0; - } \ No newline at end of file + } -- cgit v1.2.3