Skip to content

Latest commit

 

History

History
60 lines (41 loc) · 2.89 KB

README.md

File metadata and controls

60 lines (41 loc) · 2.89 KB
Raw

Steam

Steam is a minimal and responsive theme for Ghost, largely based on Vapor by Seth Lilly.

It features a clean style with single column layout and two colors, perfect for focusing on text.

With customizable partials and some nice javascript enhancements, Steam is perfect for any kind of blog, whether it is about coding, short stories or photographs.

Demo

See Steam live here.

Installation

Git - development release

Just clone the repository in the /content/themes folder of Ghost. Restart Ghost and choose Steam in the settings pane.

$ git clone https://github.com/epistrephein/Steam.git

Zip - stable release

Download the latest stable release of Steam and unzip it in the /content/themes folder of Ghost. Restart Ghost and choose Steam in the settings pane.

Customization

Activate a custom menu

Replace {{!> menu}} with {{> menu}} in default.hbs, then customize the file partials/menu.hbs using the given template.

Customize the social icons

Change the given a href addresses in partials/footer-social.hbs or replace the icons with the ones you prefer using the Font Awesome list, e.g. to add a Facebook icon add

<a href="https://www.facebook.com/username" target="_blank" title="Facebook"><i class="fa fa-2x fa-fw fa-facebook"></i> <span class="hidden">Facebook</span></a>

If you don't want the social icons section, replace {{> footer-social}} with {{!> footer-social}} in default.hbs.

Customize the blog signature

Replace the text, email address and author name in the file partials/footer-author.hbs. To remove it, replace {{> footer-author}} with {{!> footer-author}} in default.hbs.

Activate the comments

Replace {{!> comments-disqus}} with {{> comments-disqus}}, {{!> comments-facebook}} with {{> comments-facebook}} or {{!> comments-google-plus}} with {{> comments-google-plus}} in the post.hbs file.

Other customizations

Steam features Smooth Scroll: the default settings are at the bottom of default.hbs

<script>
    smoothScroll.init({
        speed: 800,
        easing: 'easeInOutCubic',
        updateURL: false,
        offset: 125,
    });
</script>

Steam features also highlight.js for syntax highlighting: you can disable it by removing the line

<script>hljs.initHighlightingOnLoad();</script>

at the bottom of default.hbs.

Caveats

Static pages are currently under development. Author pages are not yet supported: as for now, the author name only links to the custom website choosen in the settings.

License

Steam is open source and released under the MIT License, feel free to contribute.