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

github.com/josephhutch/aether.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoe Hutchinson <hutch7995@gmail.com>2020-07-14 06:00:17 +0300
committerJoe Hutchinson <hutch7995@gmail.com>2020-07-14 06:00:17 +0300
commit0b275717d39cba521ad63482bae97252fd0ede14 (patch)
tree25bc3b54b99648a1dfc4d4647818104f920502b2 /README.md
parent77dbbb025499ee602303747d2d9e6afbe3015570 (diff)
Use assets folder for bgimg and homeimg
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 6 insertions, 6 deletions
diff --git a/README.md b/README.md
index 1d1182b..db19dd7 100644
--- a/README.md
+++ b/README.md
@@ -34,18 +34,18 @@ googleAnalytics = "Your google analytics tracking ID - optional"
disqusShortname = "Your shortname for Disqus - optional"
[params]
-brand = "The name that is displayed in the top left of the website, consider it the website name"
-description = "The website's description"
-homeimg = "URL to the image used for the home button at the bottom of each post - optional"
-bgimg = "URL to the image used for the page background - optional"
-rssinmenu = whether you would like a RSS feed link to appear in the navigation menu (true, false) - optional
+ brand = "The name that is displayed in the top left of the website, consider it the website name"
+ description = "The website's description"
+ homeimg = "Path, within the 'assets' folder, of the image used for the home button at the bottom of each post - optional"
+ bgimg = "Path, within the 'assets' folder, of the image used for the page background - optional"
+ rssinmenu = whether you would like a RSS feed link to appear in the navigation menu (true, false) - optional
```
The `title` parameter is used for each page title, the title that search engines display in search results. If you would like the title shown in the top left of the page to be different from the page title, use the `brand` parameter. For instance, the title parameter for my site is `Joe Hutchinson` but the brand parameter is set to `joehutch`.
Find your `language code` [here](https://www.metamodpro.com/browser-language-codes).
-The `homeimg` and `bgimg` parameters give you the ability to customize the look of your site further. The homeimg parameter is the image used for the home button at the bottom of every page. Since the text used on the home button is white, a darker background image is preferred. If the homeimg parameter is not specified, a fallback image is used. Similarly, the bgimg parameter is used for the background of each webpage. Aether is designed to look best with a subtle tiling image for the background. If no background image is specified, the background will be a solid gray color.
+The `homeimg` and `bgimg` parameters give you the ability to customize the look of your site further. Both the homeimg and the bgimg should reside in the assets folder of your site. The homeimg parameter is the image used for the home button at the bottom of every page. Since the text used on the home button is white, a darker background image is preferred. If the homeimg parameter is not specified, a fallback image is used. Similarly, the bgimg parameter is used for the background of each webpage. Aether is designed to look best with a subtle tiling image for the background. If no background image is specified, the background will be a solid gray color.
That is the only configuration required at the site level! You can now begin writing content for your site.