From 103387d2156b0155f36252079cfe591e09d843e3 Mon Sep 17 00:00:00 2001 From: siegerts Date: Sun, 10 Feb 2019 17:30:56 -0500 Subject: update readme --- README.md | 47 ++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 46 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 84460f0..49c89c6 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,12 @@ Basic personal site theme styled with minimal tachyons. +## Features + +- ✨ Basic — HTML with a dash of style + emojis stand out more +- 🌯 Extensible — Easily leverage [tachyons](https://tachyons.io/components/) to spice it up +- + ## Getting started ### Installation @@ -24,8 +30,47 @@ For more information, read the official [documentation](https://gohugo.io/themes ### Configuration -The example configuration file can be found in the theme's `exampleSite` folder. You can just copy the `config.toml` to the root directory of your Hugo site. There are instructions in the example configuration file, feel free to change strings as you like to customize your website. +Take a look at the sample `config.toml`file located in the `exampleSite` folder. You can just copy the `config.toml` to the root directory of your Hugo site. There are instructions in the example configuration file, feel free to change strings as you like to customize your website. + +#### Content Types + +**Post** +
+Used for blog posts. Posts are listed on the `/blog` page. Run `hugo new post/.md` to create a post. +
+ +**Page** _Optional_ +
+Used for site pages. Run `hugo new page/.md` to create a page. +
+ +**Project** _Optional_ +
+Used for project pages. Extend project list with `/layouts/section/project.html`. Run `hugo new project/.md` to create a page. +
+ +#### Menu + +Menu links are specified, in order, in the theme configuration. + +For example: + +```toml +[[params.menu]] + name = "blog" + url = "blog/" + + +[[params.menu]] + name = "about" + url = "page/about" + +``` ## Acknowledgments - [tachyons](http://tachyons.io/) + +## License + +The code is available under the [MIT license](https://github.com/siegerts/hugo-theme-basic/blob/master/LICENSE). -- cgit v1.2.3