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-01 22:41:04 +0300
committerDragos Plesca <dragos.plesca@gmail.com>2015-04-01 22:41:04 +0300
commit156fbc67a98c50071b519eaa259830cc432e2efe (patch)
treef181813ecbefc516d271b8bfe9bf773a77d73267
parent32c8b48b88d7dac99f61a098d3a3d34070e035aa (diff)
Update README.md
-rw-r--r--README.md32
1 files changed, 28 insertions, 4 deletions
diff --git a/README.md b/README.md
index 507d260..884970f 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 js 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
+```