X-Git-Url: https://git.njae.me.uk/?a=blobdiff_plain;f=README.md;h=24aff05f11628d81278b3992f7a5812ad7780ac6;hb=HEAD;hp=aa775366d409334173118a5091ed5f2a765ad5ea;hpb=fba1d7cc64b98e494c87d119fc54b99cb7ad7ee1;p=ghost-theme-willow.git diff --git a/README.md b/README.md index aa77536..24aff05 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,38 @@ -# Willow Ghost Theme -Personal, responsive, minimalist and open-source theme for Ghost blogging platform. +# Willow Ghost Theme 4.1 -![Willow Ghost Theme](http://i.imgur.com/gGNeWzG.png) +Personal, responsive, minimalist and open-source theme for Ghost blogging platform. Lightweight - only 3KB of CSS and 820B of JavaScript. No jQuery, vanilla JS only. Starting version 2.0 theme is built 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 Compatibility +Theme is fully compatible with Ghost 1.X versions. The 0.X version compatible theme can be found in "version-0.X" branch. -## Styling & Compiling +## Theme Demo -Requires [Compass](http://compass-style.org/) framework to be installed. +~~This theme is currently being used on my personal blog - [https://raivis.com/](https://raivis.com/).~~ Sorry, demo is no longer available - check the screenshots below or see this page for more detailed theme overview - [https://raivis.com/willow-free-responsive-minimalist-ghost-blog-theme/](https://raivis.com/willow-free-responsive-minimalist-ghost-blog-theme/) - $ cd content/themes/[theme-folder]/assets/scss - $ compass watch ./ - -## Adding Disqus +## Compiling SASS & Minifying JavaScript -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: +Requires Grunt task runner & NPM to be installed. - (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 + $ cd content/themes/[theme-folder] + $ npm install + $ grunt -Edit the `content/themes/[theme-folder]/partials/social-links.hbs` file. +## Editing Social Links and Promo Links + +Edit the `content/themes/[theme-folder]/partials/sidebar.hbs` file. Social links are in DIV with class `c-sidebar-contact-links` and promo links are in `c-sidebar-promotion-links` DIV - just edit the anchors added inside them. + +## Enabling Disqus Comments Box + +1. Edit the `content/themes/[theme-folder]/post.hbs` file, uncomment `` partial inclusion. + +2. Replace Disqus embed code with your site code. Edit `content/themes/[theme-folder]/partials/comments.hbs` file and replace `loadDisqusComments` function body with Disqus embed code function. + +## Screenshots + +![Homepage](http://i.imgur.com/3xg6fhy.png) +--- +![Post](http://i.imgur.com/gHunzOq.png) +--- +![Author](http://i.imgur.com/I3W07B2.png)