Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/dplesca/purehugo.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDragos Plesca <dragos.plesca@gmail.com>2015-04-25 10:16:43 +0300
committerDragos Plesca <dragos.plesca@gmail.com>2015-04-25 10:16:43 +0300
commitd43e1acf519db4d3a4f6409f4a1c4edb3b4618cb (patch)
tree2c8f34d111acd1b4b3460e47efd31c50401d0630
parent0f160767d6671eeb91ab65383837244e8600c512 (diff)
parent3040dd2719f4159b81636943b9c061d0f9781a7f (diff)
Merge branch 'master' of https://github.com/dplesca/purehugo
-rw-r--r--README.md32
1 files changed, 28 insertions, 4 deletions
diff --git a/README.md b/README.md
index 507d260..6e8565b 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,37 @@
purehugo
========
-Hugo theme based on purecss from Yahoo.
+Hugo theme based on [purecss](http://purecss.io/) from Yahoo. The theme is based on [the purecss blog layout example](http://purecss.io/layouts/blog/), is responsive and has a few more features: pagination (if enabled), responsive images (through a shortcode), google analytics, disqus comments and even a mini-asset-pipeline using gulp. If you end up using it, I'd love to see what you do with it so please give me a shout on [twitter](https://twitter.com/dragos_plesca).
-## Reponsive Images
+### Config file
-For responsive images use the built-in responsive image shortcode:
+The config file for the demo site looks like this:
+```toml
+baseurl = "http://dplesca.github.io/purehugo/"
+languageCode = "en-us"
+title = "purehugo"
+theme = "purehugo"
+Paginate = 10
+disqusShortname = "xxxx"
+
+[params]
+ twitter = "dragos_plesca"
+ github = "dplesca"
+ description = "Demo site for a hugo theme"
+ google_analytics = "UA-xxxxxx-xx"
+```
+
+Notice the configuration necessary for disqus comments (just setting the disqusShortname), the twitter and github handlers (for the site sidebar), the site description and enabling Google Analytics reporting.
+
+### Syntax Highlighting
+
+Syntax highlighting is enabled by default and it uses the nice [rainbow js](http://craig.is/making/rainbows) library. All you need to do is to let rainbow.js the language of the highlighted code, using something like ````go` when writing the code in markdown.
+
+### Reponsive Images
+
+For responsive images you could use the built-in responsive image shortcode:
```
{{%/* img-responsive http://example.com/image.jpg */%}}
-``` \ No newline at end of file
+```