mirror of https://github.com/kc0bfv/ticky_tacky_dark.git

Karl
10.21.2019 8e5229078467ce5625563dacb827bd57ceb4d8fb
Readme update
1 files modified
32 ■■■■ changed files
README.md 32 ●●●● patch | view | raw | blame | history
README.md
@@ -1,6 +1,30 @@
# Page Construction
Navigation from the main page happens via a button image.  These should be 300 pixels by 300 pixels.
# Ticky Tacky Dark - Theme for Hugo
This is a multi-page theme, where the list page displays a set of image buttons linking to your sub-pages.
On sub-pages, images can appear on the left side.  These should be 480 pixels by 800 pixels.
Preview at <https://kc0bfv.github.io/ticky_tacky_dark>
In the headers, images should be 950 pixels by 200 pixels.
## Configuration
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
* msvalidate - MS validation tag
* googlesiteverification - Google site verification tag
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
* 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.
## 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`.
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.
## Usage
Put this theme in your site's themes folder, then modify the site config to specify the theme `ticky_tacky_tark`, or use the `-t ticky_tacky_dark` command line switch.