]> njoseph.me Git - hyde.git/blobdiff - README.md
Added Disqus support
[hyde.git] / README.md
index 3233a15329482b78a8bf300c5efd9dbf90a75290..70a57ec927008ea8cccbbd584dc5fb94b8620cad 100644 (file)
--- a/README.md
+++ b/README.md
@@ -13,6 +13,7 @@ It pairs a prominent sidebar with uncomplicated content.
   - [Sticky sidebar content](#sticky-sidebar-content)
   - [Themes](#themes)
   - [Reverse layout](#reverse-layout)
+  - [Disqus](#disqus)
 - [Development](#development)
 - [Author](#author)
 - [Ported by](#ported-by)
@@ -60,7 +61,7 @@ There are eight themes available at this time.
 
 ![Hyde theme classes](https://f.cloud.github.com/assets/98681/1817044/e5b0ec06-6f68-11e3-83d7-acd1942797a1.png)
 
-To use a theme, add the `themeColor` variable under `params``, like so:
+To use a theme, add the `themeColor` variable under `params`, like so:
 
 **TOML**
 ```toml
@@ -71,8 +72,9 @@ theme = "hyde"
 ```
 
 **YAML**
-```
+```yaml
 theme: "hyde"
+
 params:
   themeColor: "theme-base-09"
 ```
@@ -91,6 +93,22 @@ Hyde's page orientation can be reversed with a single class.
 </body>
 ```
 
+### Disqus
+
+You can optionally enable a comment system powered by Disqus for the posts. Simply add the variable `disqusShortname` to the `params` in your config file.
+
+**TOML**
+```toml
+[params]
+  disqusShortname = "spf13"
+```
+
+**YAML**
+```yaml
+params:
+  disqusShortname: "spf13"
+```
+
 ## Author
 **Mark Otto**
 - <https://github.com/mdo>