Update documentation to reflect wiki

6 files changed, 121 insertions, 201 deletions

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index e78c9d3..c106ed6 100644
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -107,7 +107,7 @@ worked on and we can manage it that way.
    use the following:
 
       ```
-      git merge upstream/master
+      git rebase upstream/master
       git push origin master
       ```
 
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 28098c8..93475f4 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -8,13 +8,12 @@ assignees: ''
 ---
 
 # Bug Report
-## Describe the bug
-<!-- A clear and concise description of what the bug is. -->
 
+## Describe the bug
 
+[A clear and concise description of what the bug is.]
 
 ## To Reproduce
-<!-- Steps to reproduce the behavior: -->
 
 1. Go to '...'
 2. Click on '....'
@@ -22,20 +21,14 @@ assignees: ''
 4. See error
 
 ## Expected behavior
-<!-- A clear and concise description of what you expected to happen. -->
-
 
+[A clear and concise description of what you expected to happen.]
 
 ## Screenshots
-<!-- If applicable, add screenshots to help explain your problem. -->
 
-<!-- ![Screenshot](IMGURL) -->
+[You can use `Windows+Shift+S` or `Control+Command+Shift+4` to add a screenshot to your clipboard and then paste it here.]
 
 ## Environment
-<!--
-  Please describe what you are experiencing this problem with.
-  More information helps diagnose the issue faster.
--->
 
  - **Hugo Version:** [e.g. 0.46]
  - **Browser and Version:** [e.g. Chrome 74.0.3729.108]
@@ -43,4 +36,5 @@ assignees: ''
  - **Link to Project:**
 
 ## Additional context
-<!-- Add any other context about the problem here. -->
+
+[Add any other context about the problem here.]
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index 484a646..77777dd 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -10,19 +10,17 @@ assignees: ''
 # Feature Request
 
 ## Is your feature request related to a problem?
-<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
-
 
+[A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]]
 
 ## Solution
-<!-- A clear and concise description of what you want to happen. -->
-
 
+[A clear and concise description of what you want to happen.]
 
 ## Alternatives
-<!-- A clear and concise description of any alternative solutions or features you've considered. -->
-
 
+[A clear and concise description of any alternative solutions or features you've considered.]
 
 ## Additional Context
-<!-- Add any other context or screenshots about the feature request here. -->
+
+[Add any other context or screenshots about the feature request here.]
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 7d64821..4c68258 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,44 +1,18 @@
-<!---
-  ## Prerequisites
-  - I am running the latest version of [Hugo](https://github.com/gohugoio/hugo/releases)
-  - I am using the latest version of [Hugo-Future-Imperfect-slim](https://github.com/pacollins/hugo-future-imperfect-slim/releases)
-  - I checked the [issues](https://github.com/pacollins/hugo-future-imperfect-slim/issues?utf8=%E2%9C%93&q=is%3Aissue) to make sure that this feature has not been rejected before
-  - I checked the [pull requests](https://github.com/pacollins/hugo-future-imperfect-slim/pulls?utf8=%E2%9C%93&q=is%3Apr) to make sure that this feature is not already being developed
--->
-
-<!--- Provide a general summary of your changes in the Title above -->
-
 ## Description
-<!--- Describe your changes in detail -->
-
 
+[Describe your changes in detail]
 
 ## Motivation and Context
-<!---
-  Why is this change required? What problem does it solve?
-  If it fixes an open issue, please link to the issue here by writing "Closes #XXX"
--->
 
+[Why is this change required? What problem does it solve?]
 
+[If it fixes an open issue, please link to the issue here by writing "Closes #XXX"]
 
 ## Screenshots (if appropriate):
 
-<!-- ![Screenshot](IMGURL) -->
-
-## Types of changes
-<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
-
-- [ ] Bug fix (non-breaking change which fixes an issue)
-- [ ] New feature (non-breaking change which adds functionality)
-- [ ] Breaking change (fix or feature that would cause existing functionality to change)
+[You can use `Windows+Shift+S` or `Control+Command+Shift+4` to add a screenshot to your clipboard and then paste it here.]
 
 ## Checklist:
-<!---
-  Please review the following points and put an `x` in all the boxes that apply.
-  If you're unsure about any of these, don't hesitate to ask. We're here to help!
--->
-
-- [ ] I have read the [Contributing Document](https://github.com/pacollins/hugo-future-imperfect-slim/blob/master/.github/CONTRIBUTING.md).
-- [ ] My code follows the [code style](https://github.com/pacollins/hugo-future-imperfect-slim/blob/master/.github/CONTRIBUTING.md#Style-Guide) of this project.
-- [ ] My change requires a change to the [documentation](https://github.com/pacollins/hugo-future-imperfect-slim/wiki).
-- [ ] I have updated the documentation, including `theme.toml`, accordingly.
+
+- [ ] I have updated the [documentation](https://github.com/pacollins/hugo-future-imperfect-slim/wiki), as applicable.
+- [ ] I have updated the `theme.toml`, as applicable.
diff --git a/.github/stale.yml b/.github/stale.yml
deleted file mode 100644
index 96d2a3f..0000000
--- a/.github/stale.yml
+++ /dev/null
@@ -1,17 +0,0 @@
-# Number of days of inactivity before an issue becomes stale
-daysUntilStale: 60
-# Number of days of inactivity before a stale issue is closed
-daysUntilClose: 14
-# Issues with these labels will never be considered stale
-exemptLabels:
-  - In Progress
-  - On Hold
-# Label to use when marking an issue as stale
-staleLabel: Abandoned
-# Comment to post when marking an issue as stale. Set to `false` to disable
-markComment: >
-  This issue has been automatically marked as Abandoned because it has not had
-  recent activity. It will be closed if no further activity occurs. Thank you
-  for your contributions.
-# Comment to post when closing a stale issue. Set to `false` to disable
-closeComment: false
diff --git a/README.md b/README.md
index 99d7a04..b540e8c 100644
--- a/README.md
+++ b/README.md
@@ -1,21 +1,16 @@
 # Hugo Future Imperfect Slim
 
-**Hugo Future Imperfect** *Slim* is a theme based on
-[jpescador's](https://github.com/jpescador/) port of
-[HTML5 UP's theme](http://html5up.net/future-imperfect) by the same name.  The
-goal of this theme is to continue the development of the
-[original theme](https://github.com/jpescador/hugo-future-imperfect).
-
+**Hugo Future Imperfect** *Slim* is a theme based on [jpescador's](https://github.com/jpescador/)
+port of [HTML5 UP's theme](http://html5up.net/future-imperfect) by the same name.
+The goal of this theme is to continue the development of the [original theme](https://github.com/jpescador/hugo-future-imperfect).
 This version takes that port and modernizes it with **CSS Grid** and **Modern
-Hugo functions**. In addition to the features that were present in the original
-theme, there are some additional features for you to utlize however you see fit.
-
-![Hugo Future Imperfect Screenshot](https://raw.githubusercontent.com/pacollins/hugo-future-imperfect-slim/master/images/screenshot.png)
+Hugo functions**.
 
-Check out this
-[live example site](https://themes.gohugo.io/theme/hugo-future-imperfect-slim/)
+Check out the [live demo](https://themes.gohugo.io/theme/hugo-future-imperfect-slim/)
 on the Hugo Theme Showcase.
 
+![Hugo Future Imperfect Screenshot](https://raw.githubusercontent.com/pacollins/hugo-future-imperfect-slim/master/images/screenshot.png)
+
 ## Table of Contents
 
 <!-- TOC depthFrom:2 depthTo:6 withLinks:1 updateOnSave:1 orderedList:0 -->
@@ -25,8 +20,8 @@ on the Hugo Theme Showcase.
 	- [Non-Development](#non-development)
 	- [Development](#development)
 	- [exampleSite](#examplesite)
-	- [Staticman](#staticman)
 	- [config.toml](#configtoml)
+	- [Staticman](#staticman)
 	- [Hugo's Built-In Server](#hugos-built-in-server)
 - [Shortcodes](#shortcodes)
 - [About the Author](#about-the-author)
@@ -36,35 +31,42 @@ on the Hugo Theme Showcase.
 
 ## Getting Started
 
-There are two different ways I recommend getting started and it depends on one
-of two things: are you going to help develop the theme, or do you just want to
-use it for personal use.
+Depending on how you plan to utilize the theme, there are two different ways we
+recommend getting started.
 
 ### Non-Development
 
-If you would like to stay up-to-date with the current iteration of the theme and
-don't plan to aid in the development of the theme (or don't want to aid via your
-site), I would highly recommend you add it as a submodule to your project. From
-your site directory, do the following:
+If your goal is to simply use the theme on your site *even if you plan to
+customize the theme*, and not make pull requests to this repository, you should
+add the theme as a submodule to your project.
 
-```
-mkdir themes // Creates a Themes Folder
-cd themes		 // Points to the Themes Folder
+After you have extracted the files from the `exampleSite` directory, do the
+following from within the root directory of your site:
+
+```shell
+mkdir themes     // Creates a "themes" Folder
+cd themes        // Points to the "themes" Folder
 git submodule add https://github.com/pacollins/hugo-future-imperfect-slim.git
 ```
 
-You will then have access to the theme at _themes/hugo-future-imperfect-slim_
+All of the theme files will be accessible from `themes/hugo-future-imperfect-slim`
 from within your project folder.
 
-From here, you can customize any of the files for your personal use by creating
-a dupicating the file at the project level instead of the theme level. For
-example, if you wanted to change the About Me Page Template (which is located at
-_MYPROJECT/themes/layouts/about/list.html_), I would create a new file at
-_MYPROJECT/layouts/about/list.html_ and change it to what I wanted it to be.
+If you wish to customize **any** of the files in the theme for your personal use,
+simply create a duplicate file at the project-level instead of the theme level.
+This is function that is innate to Hugo based on [Hugo's lookup order](https://gohugo.io/templates/lookup-order/)
+
+For example, if you wanted to change the About Me Page Template (`<my-project>/themes/layouts/_default/about.html`). You would create a new files at `<my-project>/layouts/_default/about.html` based on the theme file, but including your modifications
 
-This is the proper way to adjust files for personal use when they do not
-contribute to the development of the them, and it can help prevent your site
-from being incompatible with the original theme.
+This is the proper way to adjust files for personal use in a way that does not
+make your site incompatible with the theme.
+
+When you are ready to update your site to the current version of the theme, do
+the following:
+
+```shell
+git submodule update --remote --merge
+```
 
 ### Development
 
@@ -72,44 +74,50 @@ If you plan on assisting with developing the theme, you will want to have your
 own copy that is not a submodule. To do this, navigate to where you want to
 place it and do the following:
 
-```
+```shell
 git clone https://github.com/pacollins/hugo-future-imperfect-slim.git
 ```
 
 ### exampleSite
 
-Within the hugo-future-imperfect-slim folder, there will be another folder
-called _exampleSite_. The structure of the folder will look like this:
+Within the `hugo-future-imperfect-slim` folder, there will be another folder
+called `exampleSite`. This folder defines the theme's typical site structure,
+which looks like this:
 
 ```
 exampleSite
-├── config.toml
 ├── content
 │   ├── about
-│   │   ├── _index.br.md
-│   │   ├── _index.fr.md
-│   │   ├── _index.md
-│   │   └── _index.pl.md
+│   │   ├── index.fr.md
+│   │   ├── index.md
+│   │   ├── index.pl.md
+│   │   └── index.pt.md
 │   ├── blog
-│   │   ├── creating-a-new-theme.br.md
-│   │   ├── creating-a-new-theme.fr.md
-│   │   ├── creating-a-new-theme.md
-│   │   ├── creating-a-new-theme.pl.md
-│   │   ├── examples.md
-│   │   ├── goisforlovers.fr.md
-│   │   ├── goisforlovers.md
-│   │   ├── goisforlovers.pl.md
-│   │   ├── hugoisforlovers.fr.md
-│   │   ├── hugoisforlovers.md
-│   │   ├── hugoisforlovers.pl.md
-│   │   ├── migrate-from-jekyll.fr.md
-│   │   ├── migrate-from-jekyll.md
-│   │   └── migrate-from-jekyll.pl.md
+|   |   ├── _index.md
+│   │   ├── emoji-support.fr.md
+│   │   ├── emoji-support.md
+│   │   ├── markdown-syntax.fr.md
+│   │   ├── markdown-syntax.md
+│   │   ├── placeholder-text.md
+│   │   ├── rich-content.fr.md
+│   │   └── rich-content.md
 │   └── contact
-│       ├── _index.br.md
-│       ├── _index.fr.md
-│       ├── _index.md
-│       └── _index.pl.md
+│       ├── index.fr.md
+│       └── index.md
+├── data
+│   └── comments
+│       └── 6354f801456983b22c4b91ce42adfca7
+|           ├── 7f97ca70-c476-11e9-999e-498e0902dd73.json
+│           └── a69c31b0-c476-11e9-999e-498e0902dd73.json
+├── resources
+│   └── assets
+|       ├── scss
+│       |   └── scss
+│       │       ├── main.scss_b5a97001882d870cddf46d3bce56b70e.content
+│       │       ├── main.scss_b5a97001882d870cddf46d3bce56b70e.json
+│       │       ├── main.scss_f300667da4f5b5f84e1a9e0702b2fdde.content
+│       │       └── main.scss_f300667da4f5b5f84e1a9e0702b2fdde.json
+│       └── images
 ├── static
 │   ├── css
 │   │   └── add-on.css
@@ -120,66 +128,46 @@ exampleSite
 │   │   │   │   └── pic02.jpg
 │   │   │   └── 09
 │   │   │       └── pic03.jpg
+│   │   ├── 2017
+│   │   │   └── 08
+│   │   │       └── pic04.jpg
 │   │   └── main
 │   │       └── logo.jpg
 │   └── js
 │       └── add-on.js
+└── config.toml
 └── staticman.yml
 ```
 
-To get started, you will want to copy _config.toml_ from _exampleSite_ to the
-root directory of your project.
-
-### Staticman
+### config.toml
 
-If you would like static comments powered by [Staticman](https://staticman.net/),
-you will also need to copy _staticman.yml_.  You may refer to
-[this project page's Wiki page](https://github.com/pacollins/hugo-future-imperfect-slim/wiki/Staticman-config)
-for details.
+To get started, you will want to copy `exampleSite/config.toml` to the root
+directory of your project.
 
-### config.toml
+For details on the `config.toml`, please refer to the
+[wiki page](https://github.com/pacollins/hugo-future-imperfect-slim/wiki/config.toml)
 
-This file is important to the initial set-up of your project and contains all of
-the customizations that the developers feel as though you should have easy
-access to. Each prarameter listed should include a comment to help describe it's
-function.  Unless otherwise state, _true_ will turn a feature **on**, while
-_false_ will turn a feature **off**. It is structured as follows:
+### Staticman
 
+If you would like static comments powered by [Staticman](https://staticman.net/),
+you will also need to copy `exampleSite/staticman.yml` to the root directory of
+your project.
 
-```
-.Site
-├── .Params // Controls Carious Settings
-|   ├── .Meta
-|   ├── .Header
-|   ├── .Intro
-|   │   └── .Pic
-|   ├── .Sidebar
-|   ├── .Footer
-|   └── .Staticman
-|       └── .Recaptcha
-├── .Languages // Controls Multilingual Settings and Navigation
-|   ├── .En
-|   │   └── .Menu.Main
-|   ├── .Fr
-|   │   └── .Menu.Main
-|   ├── .Pl
-|   │   └── .Menu.Main
-|   ├── .Br
-|   │   └── .Menu.Main
-└── .Social  // Controls Links to Social Media
-```
+For details on the Staticman, please refer to the
+[wiki page](https://github.com/pacollins/hugo-future-imperfect-slim/wiki/staticman.yml)
 
 ### Custom JavaScript and CSS
 
-You can adapt this theme according to your preferences using your own JS or CSS code.
-To do this your can add your custom scripts to the `cssFiles` and `jsFiles`
-parameters in *config.toml*.
+You can adapt this theme according to your preferences using your own JS or CSS
+code. To do this, you can either edit the `exampleSite/static/css/add-on.css` or
+`exampleSite/static/js/add-on.js` files, or you can load your own files by adding
+them to the `cssFiles` and `jsFiles` parameters in `config.toml`.
 
 ### Hugo's Built-In Server
 
 To see a live version of your site locally, use the following command:
 
-```
+```shell
 hugo server
 ```
 
@@ -188,48 +176,31 @@ Hugo will build your site and host a server locally. You can view this live at
 
 ## Shortcodes
 
-In addition to the native [Hugo shortcodes](https://gohugo.io/extras/shortcodes/),
-the theme also includes additional shortcodes that you may find useful.
-
-## Source Code Highlighting
-
-You can enable source code hightlighting via
-[highlight.js](https://highlightjs.org).  If you want to use a language which is
-not in the [common package](https://highlightjs.org/download/) of highlight.js
-you can enable that language via `highlightjsLang` and the additional packages
-with be added to your site.
-
-```
-highlightjsLang=["yaml", "groovy"]
-```
+For details on the shortcodes beyond the native [Hugo shortcodes](https://gohugo.io/extras/shortcodes/),
+please refer to the [wiki page](https://github.com/pacollins/hugo-future-imperfect-slim/wiki/shortcodes).
 
 ## About the Author
 
-[Hugo Future Imperfect](http://html5up.net/future-imperfect) is a theme by
-[HTML5 UP](http://html5up.net). [Julio Pescador](https://jpescador.com) took the
-code provided from them and ported it over so that it could be used with Hugo.
-[Patrick Collins](https://pacollins.com) then took this port, broke it down and
-restructured it under newer Hugo functions in addition to building it
-mobile-first utlizing CSS Grid. This also allowed for the slimming of the CSS
-and JS files originally included to strip those features not used in the site
-(hence the name, _slim_). During the this time,
-[StatnMap](https://github.com/statnmap) worked on overhauling the majority of
-the theme to include Multilingual functionality - which is included here.
+[Hugo Future Imperfect](http://html5up.net/future-imperfect) is a theme by [HTML5 UP](http://html5up.net).
+[Julio Pescador](https://jpescador.com) took the code provided from them and
+ported it over so that it could be used with Hugo. [Patrick Collins](https://pacollins.com)
+then took this port, broke it down and restructured it under newer Hugo functions
+in addition to building it mobile-first utilizing CSS Grid. This also allowed for
+the slimming of the CSS and JS files originally included to strip those features
+not used in the site (hence the name, _slim_). During the this time, [StatnMap](https://github.com/statnmap)
+worked on overhauling the majority of the theme to include Multilingual
+functionality - which is included here.
 
 Since the original development had become stale and the redesign is _not_
-directly compatible with previous versions of the original
-[Hugo Future Imperfect](https://github.com/jpescador/hugo-future-imperfect),
+directly compatible with previous versions of the original [Hugo Future Imperfect](https://github.com/jpescador/hugo-future-imperfect),
 it is now in its own repo to help aid in development and prevent confusion.
 
-Please also refer to the
-[project contributors list](https://github.com/pacollins/hugo-future-imperfect-slim/graphs/contributors)
+Please also refer to the [project contributors list](https://github.com/pacollins/hugo-future-imperfect-slim/graphs/contributors)
 for everyone that has directly contributed to this version of the theme.
 
 ## License
 
-This theme is released under the
-[Creative Commons Attribution 3.0 License](https://creativecommons.org/licenses/by/3.0/).
-"[Future Imperfect](https://html5up.net/future-imperfect)" is a theme by
-[HTML5 UP](http://html5up.net) licensed under the same terms.  Please read the
-[license](https://github.com/pacollins/hugo-future-imperfect-slim/blob/master/LICENSE.md)
+This theme is released under the [Creative Commons Attribution 3.0 License](https://creativecommons.org/licenses/by/3.0/). "[Future Imperfect](https://html5up.net/future-imperfect)"
+is a theme by [HTML5 UP](http://html5up.net) licensed under the same terms.
+Please read the [license](https://github.com/pacollins/hugo-future-imperfect-slim/blob/master/LICENSE.md)
 for more information.