Clarify params in README and example site

2 files changed, 67 insertions, 38 deletions

diff --git a/README.md b/README.md
index c500820..95c1499 100644
--- a/README.md
+++ b/README.md
@@ -25,7 +25,7 @@ git clone https://github.com/josephhutch/aether.git themes/aether
 ### Website Configuration

 Customize the look and feel of aether through the config.toml file. See how to fill in the config file below.

 

-```

+```toml

 baseURL = "https://yourwebsitenamegoeshere.com/"

 languageCode = "The language code for the language the website is written in"

 title = "The website title that is used in each page title, displayed in the browser tab and search results"

@@ -34,24 +34,24 @@ googleAnalytics = "Your google analytics tracking ID - optional"
 disqusShortname = "Your shortname for Disqus - optional"

 

 [params]

-  brand = "The name that is displayed in the top left of the website, consider it the website name"

+  brand = "The name that is displayed in the top left of the website - optional, title is fallback"

   description = "The website's description"

-  facebook = "URL to your Facebook account - link will be included in the footer"

-  flicker = "URL to your Flicker account - link will be included in the footer"

-  github = "URL to your GitHub account - link will be included in the footer"

-  instagram = "URL to your Instagram account - link will be included in the footer"

-  linkedin = "URL to your LinkedIn account - link will be included in the footer"

-  patreon = "URL to your Patreon account - link will be included in the footer"

-  soundcloud = "URL to your Soundcloud account - link will be included in the footer"

-  spotify = "URL to your Spotify account - link will be included in the footer"

-  tumblr = "URL to your Tumblr account - link will be included in the footer"

-  twitch = "URL to your Twitch account - link will be included in the footer"

-  twitter = "URL to your Twitter account - link will be included in the footer"

-  vimeo = "URL to your Vimeo account - link will be included in the footer"

-  youtube = "URL to your Youtube account - link will be included in the footer"

   bgimg = "Path, within the 'assets' folder, of the image used for the page background - optional"

   headshotimg = "Path, within the 'assets' folder, of the image used for the home page header - optional"

-  rssinmenu = whether you would like a RSS feed link to appear in the navigation menu and footer (true, false) - optional

+  rssinmenu = whether you would like a RSS feed link to appear in the nav menu and footer (true, false) - optional

+  facebook = "URL to your Facebook account, icon link will be included in the footer - optional"

+  flicker = "URL to your Flicker account, icon link will be included in the footer - optional"

+  github = "URL to your GitHub account, icon link will be included in the footer - optional"

+  instagram = "URL to your Instagram account, icon link will be included in the footer - optional"

+  linkedin = "URL to your LinkedIn account, icon link will be included in the footer - optional"

+  patreon = "URL to your Patreon account, icon link will be included in the footer - optional"

+  soundcloud = "URL to your Soundcloud account, icon link will be included in the footer - optional"

+  spotify = "URL to your Spotify account, icon link will be included in the footer - optional"

+  tumblr = "URL to your Tumblr account, icon link will be included in the footer - optional"

+  twitch = "URL to your Twitch account, icon link will be included in the footer - optional"

+  twitter = "URL to your Twitter account, icon link will be included in the footer - optional"

+  vimeo = "URL to your Vimeo account, icon link will be included in the footer - optional"

+  youtube = "URL to your Youtube account, icon link will be included in the footer - optional"

 

 [markup]

   [markup.highlight]

diff --git a/exampleSite/content/posts/aether-theme/index.md b/exampleSite/content/posts/aether-theme/index.md
index 966ffb2..64a423b 100644
--- a/exampleSite/content/posts/aether-theme/index.md
+++ b/exampleSite/content/posts/aether-theme/index.md
@@ -32,54 +32,83 @@ git clone https://github.com/josephhutch/aether.git themes/aether
 Add the following parameters to your config file if they are not present already.

 

 ```toml

-baseURL = "https://yourwebsitenamegoeshere.com"

-languageCode = "your language code"

-title = "your website title"

+baseURL = "https://yourwebsitenamegoeshere.com/"

+languageCode = "The language code for the language the website is written in"

+title = "The website title that is used in each page title, displayed in the browser tab and search results"

 theme = "aether"

-googleAnalytics = "Your google analytics tracking ID"

+googleAnalytics = "Your google analytics tracking ID - optional"

+disqusShortname = "Your shortname for Disqus - optional"

 

 [params]

-brand = "the title displayed in the nav bar - optional"

-description = "your website's description"

-homeimg = "url to the image used for the home button - optional"

-bgimg = "url to the image used for the background - optional"

+  brand = "The name that is displayed in the top left of the website - optional, title is fallback"

+  description = "The website's description"

+  bgimg = "Path, within the 'assets' folder, of the image used for the page background - optional"

+  headshotimg = "Path, within the 'assets' folder, of the image used for the home page header - optional"

+  rssinmenu = whether you would like a RSS feed link to appear in the nav menu and footer (true, false) - optional

+  facebook = "URL to your Facebook account, icon link will be included in the footer - optional"

+  flicker = "URL to your Flicker account, icon link will be included in the footer - optional"

+  github = "URL to your GitHub account, icon link will be included in the footer - optional"

+  instagram = "URL to your Instagram account, icon link will be included in the footer - optional"

+  linkedin = "URL to your LinkedIn account, icon link will be included in the footer - optional"

+  patreon = "URL to your Patreon account, icon link will be included in the footer - optional"

+  soundcloud = "URL to your Soundcloud account, icon link will be included in the footer - optional"

+  spotify = "URL to your Spotify account, icon link will be included in the footer - optional"

+  tumblr = "URL to your Tumblr account, icon link will be included in the footer - optional"

+  twitch = "URL to your Twitch account, icon link will be included in the footer - optional"

+  twitter = "URL to your Twitter account, icon link will be included in the footer - optional"

+  vimeo = "URL to your Vimeo account, icon link will be included in the footer - optional"

+  youtube = "URL to your Youtube account, icon link will be included in the footer - optional"

+

+[markup]

+  [markup.highlight]

+    style = "igor"

 ```

 

 The `title` parameter is used for each page title, the title that search engines display in search results. If you would like the title shown in the top left of the page to be different from the page title, use the `brand` parameter. For instance, the title parameter for my site is `Joe Hutchinson` but the brand parameter is set to `joehutch`.

 

-The `homeimg` and `bgimg` parameters give you the ability to customize the look of your site further. The homeimg parameter is the image used for the home button at the bottom of every page. Since the text used on the home button is white, a darker background image is preferred. If the homeimg parameter is not specified, a fallback image is used. Similarly, the bgimg parameter is used for the background of each webpage. Aether is designed to look best with a subtle tiling image for the background. If no background image is specified, the background will be a solid gray color.

+Find your `language code` [here](https://www.metamodpro.com/browser-language-codes).

+

+The `bgimg` parameters give you the ability to customize the look of your site further. The homeimg should reside in the assets folder of your site. The homeimg parameter is the image used for the home button at the bottom of every page. Since the text used on the home button is white, a darker background image is preferred. If the homeimg parameter is not specified, a fallback image is used. Aether is designed to look best with a subtle tiling image for the background. If no background image is specified, the background will be a solid gray color.

+

+The default syntax highlighter `style` does not look great with aether so I recommend using igor. If you want to change the highlighter theme you can specify a different one from [this list](https://xyproto.github.io/splash/docs/all.html). To configure the syntax highlighter further, such as adding line numbers, check out [this Hugo doc section](https://gohugo.io/getting-started/configuration-markup#highlight).

 

 That is the only configuration required at the site level! You can now begin writing content for your site.

 

 ### Creating content

 Make a new blog post by executing `hugo new posts/postnamehere/index.md` in your shell. At the top of the new markdown file, is what's called the front matter. The front matter is the page's metadata that determines how Hugo and aether generate the HTML for your post. Below you can find what the front matter should contain for a new post and what each of the parameters mean.

 

-```properties

+```yaml

 ---

-title: "The title of your post"

-date: date the post was generated

+title: "The title of the post"

+date: date the post was generated (automatically generated)

 description: "Description of the post (displayed in the post's card)"

-categories: ["add comma separated categories here", "another category"]

-featuredImage: "url to the page's featured image"

-featuredImageDescription: "Description for the featured image, used as the alt text"

-dropCap: if the first letter should be a large decorative capital letter (true, false)

-displayInMenu: if post is listed in the navigation menu (true, false)

-displayInList: if post is listed on the home page and category pages (true, false)

-draft: if the page is a draft (true, false)

+categories: ["Add comma separated categories here", "another category"]

+toc: if the post should include a table of contents (true, false)

+displayInMenu: if the post should show up in the navigation menu (true, false)

+displayInList: if the post should be listed on the home page and category pages (true, false)

+draft: if the post is a draft (true, false)

+resources:

+- name: featuredImage

+  src: "Filename of the post's featured image, used as the card image and the image at the top of the article"

+  params:

+    description: "Description for the featured image, used as the alt text"

+    attribution:

+      name: "Name of person to attribute image to"

+      link: "optional URL to persons site"

 ---

 ```

 

 The `displayInMenu` and `displayInList` parameters are used to determine where your content is displayed. Posts typically have displayInMenu set to false so that the post is not a menu option, and displayInList set to true so it shows up on the homepage's list of posts and in category page lists. An About Me page, on the other hand, would have displayInMenu set to true and displayInList set to false.  That will allow the About Me page to be accessible from the menu but not displayed in the homepage's list of posts.

 

-The `categories` parameter is used to group similar posts in category pages. Category pages are accessible from the menu and list all posts with the same category.

+The `categories` parameter is used to group similar posts in category pages. Category pages are accessible from the menu and list all posts within the same category.

 

 The `dropCap` parameter is used to determine if the first letter of a post should be a dropped capital. A dropped capital letter is the large decorative letter at the beginning of a book or section.

 

 Add an interesting description and a good image to each post to get the most value from this theme.

 

-Aether takes advantage of [page bundles](https://gohugo.io/content-management/page-bundles/) to optimize your images for your site.  This may require you to update the way your content is structured, also see [content organization](https://gohugo.io/content-management/organization/).  Use the `image` and `smallimg` shortcodes to take full advantage of image optimization.

+Aether takes advantage of [page bundles](https://gohugo.io/content-management/page-bundles/) to optimize your images for your site.  This may require you to update the way your content is structured, also see [content organization](https://gohugo.io/content-management/organization/).  Use the `image` and `smallimg` shortcodes to take full advantage of image optimization.  Also, the `featuredImage` resource must exist in the post's page bundle.

 

-Posts are written in markdown and LaTeX (for math symbols and equations). You can find tons of information on how to format your posts with markdown and LaTeX on the web.

+Posts are written in markdown. You can find how to write in markdown from this [markdown cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet).

 

 ### Further Customization

 To change the heading and subtext at the top of list pages just add a \_index.md file in the folder that the list page is generated from. For example to change the heading at the top of the homepage, add an \_index.md file to the content folder with the following parameters.