diff options
author | Aos <aosdab@gmail.com> | 2017-12-13 05:23:28 +0300 |
---|---|---|
committer | Aos <aosdab@gmail.com> | 2017-12-13 05:23:28 +0300 |
commit | b0ba8df443a3b68f03f487047fa02955db6a139d (patch) | |
tree | 4cc58cbecb60a42465cefa0e9864a9a8250f43be /README.md | |
parent | 4cab67801920f5576afeeae3f7eec610db16bd61 (diff) |
Improved readme significantly
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 61 |
1 files changed, 57 insertions, 4 deletions
@@ -14,14 +14,67 @@ A live version of this theme can be found ## Table of Contents * [Features](#features) -* Getting Started -* License +* [Getting Started](#getting-started) +* [Customizing](#customizing) +* [License](#license) ## Features The main features of this theme include: * Multiple categories as navigation tabs * Tags and categories have their own pages * Syntax highlighting with `highlightjs` -* Footer with variable social media links +* Footer with variable social links and RSS * Google analytics enabled -* Page load speed optimizations +* Page load speed optimizations + +## Getting Started +If you have not already created a blog, I recommend you check out my [getting +started guide](https://aos.github.io/2017/11/23/practical-guide-to-setting-up-a-hugo-blog/) for a comprehensive overview. Otherwise, just download it or clone it into +your `themes/` directory: +`$ cd themes && git clone https://github.com/aos/temple.git` +Then reference it in your `config`: +``` +theme = "temple" +``` +Or when building the site, pass it in to the CLI: +``` +$ hugo -t temple +``` + +## Customizing +Your `config` file will hold all your options: +``` +baseURL = "https://aos.github.io/" +languageCode = "en-us" +title = "Your Blog Title" +theme = "temple" +# If not set, it will not appear. Otherwise it will show below your footer links +copyright = "(c) 2008 - 2014" + +[params] + # Enables syntax highlighting + highlight = true + # Supports highlighting for languages not included in the original pack + # See https://highlightjs.org/download/ + hjslangs = [go, elixir] + +# Builds a list page for each category given +[taxonomies] + tag = "tags" + category = "categories" + +[author] + name = "Aos Dabbagh" + github = "aos" + email = "your@email.com" + gaid = "Your Google Analytics ID" + twitter = "twitterID" +``` + +There is also a fixed `About` page on the navbar. Create it using: +``` +$ hugo new about +``` + +## License +Licensed under the MIT License. See the [LICENSE](LICENSE). |