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

github.com/your-identity/hugo-theme-dimension.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavide Asnaghi <30296575+d-asnaghi@users.noreply.github.com>2021-05-22 00:43:08 +0300
committerGitHub <noreply@github.com>2021-05-22 00:43:08 +0300
commit2474081b7846ce0e211c57b86ed84989548a777d (patch)
tree743bdd33d5de8c0266f0ec02717aee9828727c8e
parenteefb2b7f1de322eb433c86fb386ac30ffb26cdfa (diff)
parent503e7566c9a9c115e1efc96dd5a306aff876d035 (diff)
Merge pull request #20 from adsail/icon-svg-docsHEADmaster
Clarify background/icon usage in README, refine logo CSS
-rw-r--r--README.md51
-rw-r--r--static/assets/css/main.css6
2 files changed, 56 insertions, 1 deletions
diff --git a/README.md b/README.md
index 7d13a74..21440a4 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,56 @@ background: "<path or link to image>"
logo: "<path or link to image>"
```
+### `background` and `logo` Params
+
+As indicated above, `background` and `logo` can be an image 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.
+
+Given the following repo structure:
+```
+ .
+ ├── config.toml
+ ├── content
+ │ ├── posts
+ │ │ └── _index.md
+ │ ├── _index.md
+ │ └── elements.md
+ ├── static
+ │ └── images
+ │ ├── custom_bg.jpg
+ │ └── custom_logo.svg
+ └── 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"
+ logo: "images/custom_logo.svg"
+ ---
+```
+
+...or in `content/posts/_index.md` as:
+```yaml
+ ---
+ title: Posts
+ description: A great human's posts
+ background: "../images/custom_bg.jpg"
+ logo: "../images/custom_logo.svg"
+ ---
+```
+
+Both fields may also be a URL to an online asset, such as:
+```yaml
+ ---
+ title: Posts
+ description: A great human's posts
+ logo: "https://upload.wikimedia.org/wikipedia/commons/8/8e/Font_Awesome_5_regular_gem.svg"
+ ---
+```
+
## 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
+ }