X-Git-Url: https://git.njae.me.uk/?a=blobdiff_plain;f=README.md;h=4bea5c258bf05db04f4c7117f6ed7bb03f69ed4f;hb=ecfdbab0574b9e06b4de30fd05a193ddb50e7dc2;hp=aa775366d409334173118a5091ed5f2a765ad5ea;hpb=fba1d7cc64b98e494c87d119fc54b99cb7ad7ee1;p=ghost-theme-willow.git diff --git a/README.md b/README.md index aa77536..4bea5c2 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,30 @@ -# Willow Ghost Theme +# Willow Ghost Theme 3.0 + Personal, responsive, minimalist and open-source theme for Ghost blogging platform. +Lightweight - only 2.9KB of CSS and 820B of JavaScript. No jQuery, vanilla JS only. +Version 2.0 comes with SASS in BEM style using ITCSS (http://itcss.io/) architecture. + +![Willow Ghost Theme](http://i.imgur.com/a8WfkoS.png) + +## Theme Demo -![Willow Ghost Theme](http://i.imgur.com/gGNeWzG.png) +This theme is currently being used on my personal blog - [https://raivis.com/](https://raivis.com/). -## Demo +## Compiling SASS & Minifying JavaScript -This theme is currenly used on my [personal blog](https://raivis.com/). +Requires Grunt task runner & NPM to be installed. -## Styling & Compiling + $ cd content/themes/[theme-folder] + $ npm install + $ grunt -Requires [Compass](http://compass-style.org/) framework to be installed. +## Editing Social Links and Promo Links - $ cd content/themes/[theme-folder]/assets/scss - $ compass watch ./ - -## Adding Disqus +Edit the `content/themes/[theme-folder]/partials/sidebar.hbs` file. -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: +## Enabling Disqus Comments Box - (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 +1. Edit the `content/themes/[theme-folder]/post.hbs` file, uncomment "comments" partial +inclusion. -Edit the `content/themes/[theme-folder]/partials/social-links.hbs` file. +2. Replace Disqus embed code with your site code - https://disqus.com/admin/universalcode/