bump min_version in theme.toml, edited docs for clarityv0.0.2

2 files changed, 33 insertions, 19 deletions

diff --git a/README.md b/README.md
index 454217a..58c564c 100644
--- a/README.md
+++ b/README.md
@@ -5,10 +5,12 @@ Blogs are for reading and sharing. This theme tries to make both of those better
 `min_night` is built on top of [Minimal](https://github.com/calintat/minimal), and keeps a lot of the cool original features:
 
 - Bootstrap
+- GoogleAnalytics
 - GoogleFonts
 - FontAwesome
 - HighlightJS
 
+
 It also gets a bunch of new add-ons:
 
 - A night-mode toggle, with HTML5 storage to remember view preferences
@@ -44,7 +46,7 @@ Submodules are better because it makes updating the theme easier for future you.
 $ git submodule update --remote themes/min_night
 ```
 
-Personally I use this theme via the `R` package `blogdown`, and you can too like this:
+Personally I use this theme via the `R` package `blogdown`, and you can too, like this:
 
 ```
 library(blogdown)
@@ -57,51 +59,61 @@ To configure most of the customizations in this theme all you need to do is edit
 
 ### Colors
 
-- The accent colour can be changed by using the `accent` field in `config.toml`. This is the color of the navbar and footer in day-mode and this is also the color of the body background of your site in night-mode. Dark colors work best.
-
-- You can also change the background color of the main page by using `backgroundColor`. Default is light grey for easy eye reading. The navbar and footer are always light and dark in the their respective modes.
-
-Example:
 ```toml
 [params]
     accent = "#006264"
     backgroundColor = "#f5f5f5"
 ```
-You should always use hex codes.
 
-### Fonts
+- `accent` changes the color of the navbar and footer in day-mode and the color of the body background of your site in night-mode. Dark colors work best.
+
+- `backgroundColor` changes the background color of the body. The default is light grey for easy eye reading.
 
-The theme uses [Google Fonts](https://fonts.google.com) to load its font. To change the font:
+Always use hex codes.
+
+### Fonts
 
 ```toml
 [params]
-    font = "Mina" # should match the name on Google Fonts!
+    font = "Mina"
 ```
 
-### Syntax highlighting
+This theme uses [Google Fonts](https://fonts.google.com), so go nuts.
 
-The theme supports syntax highlighting thanks to [highlight.js](https://highlightjs.org). You can change the color scheme via the `highlightStyle` param. Checkout out the options [here](https://highlightjs.org/static/demo/), make sure your main languages render well. You control the languages that are highlighted with the `highlightLanguages` param.
 
-For best aesthetics with dark-mode, I reccommend choosing a light background style that matches your `accent` color. 
+### Syntax highlighting
 
 ```toml
 [params]
     highlight = true
     highlightStyle = "solarized-dark"
-    highlightLanguages = ["r", "go"]
+    highlightLanguages = ["r", "python", "bash"]
 ```
-The style and languages should be written in hyphen-separated lowercase.
+
+The theme supports syntax highlighting thanks to [highlight.js](https://highlightjs.org), which is turned on by default. Checkout out the available palette options [here](https://highlightjs.org/static/demo/). Note `highlightStyle` param should be hyphen-separated lowercase.
+
+Make sure your main languages render well and keep control on the languages that get special highlighted.
+
+For best aesthetics with dark-mode, I reccommend choosing a light background style that matches your `accent` color. 
 
 ### Favicons
 
 This theme comes equipped with stock favicons modeled as hex stickers.
 
-To update those, pick out an image of your choosing head over to [RealFaviconGenerator](https://realfavicongenerator.net/) and go through their process. Be sure to append the path `/img/favicon/` at the last step or be prepared to edit the `header.html` file by hand. Download, unzip and place your new files in `quick/static/`. Now you have favicons for everything, branding!
+To update those, pick out an image and head over to [RealFaviconGenerator](https://realfavicongenerator.net/). Go through their build process and append the path `/img/favicon/` at the last step when you download. Just unzip and drop all of the new files in `quick/static/img/favicon/`. Now you have favicons for everything from tablets to tiles, that's tight.
+
+### Site Logo
 
-The site logo defaults to using the 192x192 Android favicon but you can change the path for `logo` param in `config.toml`
+The site logo defaults to using the 192x192 Android favicon but you can change the path for `logo` param in `config.toml`. This could be a headshot, another hex-sticker or something completely different, but if you want to change the image dimensions drastically, you may have to tweak `layouts/index.html` directly to get a good result.
 
 ### Social Sharing
 
+You must change `baseURL` to your current domain for this feature to work properly.
+
+```toml
+baseURL = "your_domain.com"
+```
+
 The current set up has two TwitterCard/OpenGraph options depending on the params you specify in your post's front matter. If you add the param `twitter_img` to a post, with the valid image path, then a summary card with large image will be shown. If you don't provide `twitter_img` then a summary card with the site logo will be shown instead. For best scaling large image summary wants a 2:1 ratio image and regular summary wants 1:1. The post `exampleSite/creating-a-new-theme.md` has been tweaked to include these new params, so you can template and test off of that.
 
 The summary description will use the one provided in a post's front matter if it exists or use the generic site description from `config.toml`. You should also adjust the `twitterAuthor` and `twitterSite` params in `config.toml` to point to your account. You can check how your cards are rendering once your website is being publish with the [TwitterCard Validator](https://cards-dev.twitter.com/validator).
@@ -109,7 +121,9 @@ The summary description will use the one provided in a post's front matter if it
 
 ## Going forward
 
-This theme is something I have been working on for the last 6-months and feel like it is finally ready (enough) to share with the world. I'm sure there a wrinkles in some of it that I have yet to find, so if you get unexpected behavior post an issue and try to keep it as minimal as possible. Ideally bug reports would be reproducible using the [QuickStart tutorial](https://gohugo.io/getting-started/quick-start/) plus whatever changes cause the problem.
+This theme is something I have been working on for the last 6-months and feel like it is finally ready (enough) to share with the world. I'm sure there a wrinkles in some of it that I have yet to find.
+
+If you get unexpected behavior post an issue and try to keep it as minimal as possible. Ideally bug reports would be reproducible using the [QuickStart tutorial](https://gohugo.io/getting-started/quick-start/) plus whatever changes cause the problem.
 
 Pull requests are literally the best thing since ever, so if you have the idea (and the time) to add something to `min_night` do it! I promise I will respond quickly.
 
diff --git a/theme.toml b/theme.toml
index 1d9332a..73bf1e9 100644
--- a/theme.toml
+++ b/theme.toml
@@ -5,7 +5,7 @@ description = "An easy on the eyes blog theme with night-mode."
 homepage = "http://github.com/nathancday/min_night"
 tags = ["blog", "night-mode"]
 features = ["twitter-cards"]
-min_version = "0.30.2"
+min_version = "0.35"
 
 [author]
   name = "Nate Day"