diff options
author | Jeremy Bise <jeremy.bise@thosegeeks.com> | 2019-04-17 15:31:41 +0300 |
---|---|---|
committer | Jeremy Bise <jeremy.bise@thosegeeks.com> | 2019-04-17 15:31:41 +0300 |
commit | a0ed8464e0494b62734352bb534168dc83107798 (patch) | |
tree | 9ad1d2ba69731381157e114ac285ccc23c4b5830 | |
parent | cf5419e1ab71bae5af979d716bea47777ebdc961 (diff) |
update readme
-rw-r--r-- | README.md | 33 |
1 files changed, 28 insertions, 5 deletions
@@ -1,12 +1,13 @@ # Twenty Nineteen Hugo -This is a Hugo port of WordPress's Twenty Nineteen theme. +This is a [Hugo](https://gohugo.io) port of WordPress's Twenty Nineteen theme. ## Highlights - Accent color configurable via config.toml -- Featured images and image filter effect works -- Social menu icons all ported using Hugo's built-in menus +- Featured images via `image:` in your post or page frontmatter +- Featured image filter effect works and can be disabled +- Menu locations and social menu icons all work using Hugo's built-in menus - Syntax highlighting included with the Monokai Light syntax theme ## Installation @@ -32,8 +33,7 @@ From the root of your site: ## Content Notes -- To set a featured image for a post or page, add `image: /path/to/image.jpg` to your frontmatter. -- +- To set a featured image for a post or page, add `image: /path/to/image.jpg` to your post or page's frontmatter. ## Available Site Params @@ -47,6 +47,29 @@ Some theme features can be configured in `config.toml`. Here are the options: disable_image_filters = false # Setting to true disables the color filter feature on images. Defaults to false. ``` +## Menus + +The theme includes three menu locations: `main`, `social` and `footer`. + +You can include pages in the `main` and `footer` menus using any of Hugo's documented methods. + +The social menu can be configured in `config.toml` using this example: + +```toml +[menu] + [[menu.social]] + identifier = "github" + name = "Github" + url = "https://github.com/gohugoio" + [menu] + [[menu.social]] + identifier = "twitter" + name = "Twitter" + url = "https://twitter.com/gohugoio" +``` + +The theme uses the `identifier` to determine which icon to show. For a listing of which icons are available, check out the [social icons partial folder](https://github.com/jeremybise/twentynineteen-hugo/tree/master/layouts/partials/icons/social). + ## Syntax Highlighting Add pygments config to your `config.toml`: |