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

github.com/kc0bfv/ticky_tacky_dark.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKarl <kc0bfv@gmail.com>2020-02-01 03:26:08 +0300
committerKarl <kc0bfv@gmail.com>2020-02-01 03:26:08 +0300
commit71b93fb760c17d5f7b22f47c1b8b50c2b57c2165 (patch)
treefbf8063f6c953a735bdd2f502b14b7f7029ecd47 /README.md
parentf9fb5b08eb3edd8469f3033381f96079624fee46 (diff)
Author fixes, add opengraph and twitter cards
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 8 insertions, 7 deletions
diff --git a/README.md b/README.md
index de332ba..1eed679 100644
--- a/README.md
+++ b/README.md
@@ -9,27 +9,28 @@ Preview at <https://kc0bfv.github.io/ticky_tacky_dark>
The exampleSite demonstrates the features unique to this theme. In your site config params section the following extra parameters are supported:
* `favicon` - the favicon URL, relative to your site (placed in header meta tag)
-* `webmasterEmail` - the webmaster email displayed in the footer
-* `author` - the author for the header meta tag
* `description` - the description for the header meta tag
-* `headerimages` - a list of relative image URLs for the header of each page
+* `images` - a list of relative image URLs for the header of each page
* `msvalidate` - MS validation tag
* `googlesiteverification` - Google site verification tag
+Additionally, `Author.name` and `Author.email` in the site config will display as the author and webmaster email.
+
Pages you add have custom front matter options:
* `buttonimage` - the relative image URL for the page's button on the front page
-* `sideimages` - a list of relative image URLs for the left sidebar on the page
-* `sideimagealt` - the alternate text for the page's left sidebar image
+* `images` - a list of relative image URLs for the left sidebar on the page
+* `imagealt` - the alternate text for the page's left sidebar image
* `weight` - an integer that specifies page ordering for the front page. If you want the buttons and navbar items to show pages in a specific order, specify the ordering via weight. Ordering goes from lowest weight to highest, left to right, top to bottom.
+* `author.name`, `author.email` - overrides the site author name and email
## Page Construction
Navigation from the main page happens via a button image. These images are, optimally, 300x300 pixels. Specify these button image URLs in a page's front matter with the `buttonimage` option.
-On sub-pages, images can appear on the left side. Sizing can vary there, but at full size images come out as about 277.5 pixels, and a size of about 300x500 pixels works nicely. You can specify multiple images for a sub-page, and they'll be randomly selected on load. Specify them as a list of image URLs on the page front matter, with option `sideimages`.
+On sub-pages, images can appear on the left side. Sizing can vary there, but at full size images come out as about 277.5 pixels, and a size of about 300x500 pixels works nicely. You can specify multiple images for a sub-page, and they'll be randomly selected on load. Specify them as a list of image URLs on the page front matter, with option `images`.
-Header images are, optimally, 950x200 pixels. Specify these in the site configuration as a list of image URLs with option `headerimages`. One will be randomly selected on page load.
+Header images are, optimally, 950x200 pixels. Specify these in the site configuration as a list of image URLs with option `images`. One will be randomly selected on page load.
## Custom Shortcode