heimoshuiyu/aether
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Joe Hutchinson
2018-12-14 15:40:18 -05:00
committed by GitHub
parent 8c1dce8635
commit 148227ea92
1 changed files with 12 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@@ -4,6 +4,7 @@ Aether is a Hugo theme for blogs that emphasizes motion, depth, and material as
## Features ## Features
- Content is displayed in cards that use movement and depth - Content is displayed in cards that use movement and depth
- Category pages that group similar articles are automatically generated and added to the menu - Category pages that group similar articles are automatically generated and added to the menu
- Customizable website background image and home button image
- Looks good on any screen using responsive web design - Looks good on any screen using responsive web design
## Installation ## Installation
@@ -17,6 +18,7 @@ Set the theme to aether in the config file.
## Usage ## Usage
### Website Configuration ### Website Configuration
The config.toml file allows you to change the look and feel of your blog.
```toml ```toml
baseURL = "https://yourwebsitenamegoeshere.com/" baseURL = "https://yourwebsitenamegoeshere.com/"
languageCode = "Your language code" languageCode = "Your language code"
@@ -31,16 +33,18 @@ bgimg = "URL to the image used for the page background - optional"
``` ```
### Creating content ### Creating content
Make a new post by executing `hugo new posts/postnamehere.md` in your shell. Open the new file, update the front matter, and you're on your way.
``` ```
title: "Aether: A Clean Theme for Hugo Websites" title: "The title of your post"
date: 2018-05-02T14:33:42-04:00 date: date the post was generated
description: "Aether is new theme for Hugo that emphasizes motion, depth, and material as design elements. Distracting styling and page elements are forgone to focus on the content." description: "Description of the post (displayed in the post's list card)"
categories: ["Web-Dev"] categories: ["Add comma seperated categories here", "another category"]
featuredImage: "/img/mdd-macbook.jpg" featuredImage: "URL to the page's featured image"
menu: false menu: whether you would like the post to show up in the navigation menu
list: true list: whether you would like the post to show up on list pages
draft: false draft: if the page is a draft
``` ```
## Helpful Links ## Helpful Links
[Hugo Documentation](https://gohugo.io/documentation/) [Hugo Documentation](https://gohugo.io/documentation/)