diff options
author | Andrew Sail <andrew@andrewsail.com> | 2021-05-20 06:10:39 +0300 |
---|---|---|
committer | Andrew Sail <andrew@andrewsail.com> | 2021-05-20 06:10:39 +0300 |
commit | 1cb01a90eefb59d6db2dfe49a20fcf8060425c24 (patch) | |
tree | 331e1123832e1e15faa6e74065895d3c514a88d1 /README.md | |
parent | eefb2b7f1de322eb433c86fb386ac30ffb26cdfa (diff) |
clarify background/icon usage in README, css to remove dotted line from logo
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 40 |
1 files changed, 40 insertions, 0 deletions
@@ -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: "<path or link to image>" logo: "<path or link to image>" ``` +### `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: |