X-Git-Url: https://git.njae.me.uk/?a=blobdiff_plain;ds=sidebyside;f=README.md;h=4238a39af6a4ac52fc7a4909ecea21cf4305fa53;hb=dcf1cd5add0ee12fe78f10bf8b618c744ec5128d;hp=aa775366d409334173118a5091ed5f2a765ad5ea;hpb=fba1d7cc64b98e494c87d119fc54b99cb7ad7ee1;p=ghost-theme-willow.git diff --git a/README.md b/README.md index aa77536..4238a39 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,23 @@ -# Willow Ghost Theme -Personal, responsive, minimalist and open-source theme for Ghost blogging platform. +# Willow Ghost Theme 2.0 -![Willow Ghost Theme](http://i.imgur.com/gGNeWzG.png) +Personal, responsive, minimalist and open-source theme for Ghost blogging platform. +Lightweight - only 2.8KB of CSS and 828B of JavaScript. No jQuery, vanilla JS only. +Version 2.0 comes with SASS in BEM style using ITCSS (http://itcss.io/) architecture. -## Demo +![Willow Ghost Theme](http://i.imgur.com/a8WfkoS.png) -This theme is currenly used on my [personal blog](https://raivis.com/). +## Theme Demo -## Styling & Compiling +This theme is currently being used on my personal blog - [https://raivis.com/](https://raivis.com/). -Requires [Compass](http://compass-style.org/) framework to be installed. +## Compiling SASS & Minifying JavaScript - $ cd content/themes/[theme-folder]/assets/scss - $ compass watch ./ - -## Adding Disqus +Requires Grunt task runner & NPM to be installed. -Open the `content/themes/[theme-folder]/post.hbs` file, -lookup `/* Paste Your Disqus Embed Code Here */` -line and replace it with your Disqus embed code, which usually looks like this: + $ cd content/themes/[theme-folder] + $ npm install + $ grunt - (function() { - var d = document, s = d.createElement('script'); - s.src = '//yourdisqussite.disqus.com/embed.js'; - s.setAttribute('data-timestamp', +new Date()); - (d.head || d.body).appendChild(s); - })(); - -## Editing Social Links +## Editing Social Links and Promo Links -Edit the `content/themes/[theme-folder]/partials/social-links.hbs` file. +Edit the `content/themes/[theme-folder]/partials/sidebar.hbs` file.