GithubHelp home page GithubHelp logo

epistrephein / steam Goto Github PK

View Code? Open in Web Editor NEW
167.0 11.0 53.0 891 KB

A clean and minimal theme for Ghost.

License: MIT License

CSS 49.63% HTML 47.60% JavaScript 2.76%
ghost theme ghost-theme minimal responsive

steam's Introduction

Steam

Steam is a minimal and responsive theme for Ghost, forked from Vapor.

It features a clean and essential style with single column layout, beautiful typography, two colors, customizable partials and some nice javascript enhancements.

Steam showcase

Installation

Clone the repository in the /content/themes folder of Ghost or upload the latest release zip from the settings. Restart Ghost and choose Steam in the design pane.

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

Customization

Change the theme color

By default Steam uses a flat green theme color. The css for the colors are in a separate partial for easy customization: just edit partials/theme-colors.hbs, replacing #33cc99 with your light shade and #178b6b with your dark shade.

Previous versions of Steam included premade colors partials that could just be turned on and off. These have since been removed for simplicity, so here are the values that were used if you want to keep your colors the way they were.

Color Light Dark
Green #33cc99 #178b6b
Blue #3498db #2079b4
Orange #ff9d00 #d88500
Red #f05948 #c62310

Customize the social icons

Facebook and Twitter icons in the footer are automatically displayed if defined in the general settings of Ghost.

If you want to add custom icons and links, duplicate any of them outside of the conditional tags and replace the url and the icon using the Font Awesome list, e.g. to add a GitHub icon

<a href="https://github.com/username" target="_blank" rel="noopener" title="GitHub"><i class="fa fa-2x fa-fw fa-github"></i> <span class="hidden">GitHub</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.

Hide post author section

If you don't want to show the author section (which is profile picture, bio, website and location) at the bottom of posts, replace {{> post-author}} with {{!> post-author}} in post.hbs.

Activate the comments

Replace {{!> disqus}} with {{> disqus}} in post.hbs and in page.hbs (if you want them in static pages too), then add your Disqus ID in partials/disqus.hbs.

Add Twitter, Google Webmaster and Facebook meta

Replace {{!> meta}} with {{> meta}} in default.hbs, then customize the content of partials/meta.hbs.

Activate Google Analytics

After you've created your Google Analytics account, change {{!> google-analytics}} to {{> google-analytics}} in default.hbs, ensuring to replace YOUR_TRACKING_CODE with your actual tracking code.

Custom favicon and apple-touch-icon

To customize the favicon and/or apple-touch-icon of your blog replace favicon.ico, the 16x16 and 32x32 favicon.png and the 180x180 appletouchicon.png in /assets/img/.

JavaScript

Smooth Scroll

Steam features Smooth Scroll for nice scrolling animations. The default settings are in js/steam.js

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

Smooth Scroll is automatically injected in footnotes refs and backrefs when created via their markdown syntax.

This is the body of the post with a footnote ref[ˆ1] somewhere.

[^1]: End of the post with the footnote text.
highlight.js

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

hljs.initHighlightingOnLoad();

in js/steam.js

You can force a code block into a specific language highlighting by appending the lang name, e.g.:

```ruby
puts "Hello, World!"
```

If you want to suppress the highlighting for a particular code block, you can use nohighlight:

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

Contributing

Bug reports and pull requests are welcome on GitHub.

This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Code of Conduct.

You can contribute changes by forking the project and submitting a pull request. To get started:

  1. Fork the repo
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new pull request

License

This project is released under the terms of the MIT license. See LICENSE for further details.

steam's People

Contributors

epistrephein avatar kdelfour avatar kevinbrechbuehl avatar leandros avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

steam's Issues

Cannot change favicon

Hi,
I'm using your theme and I'm trying to change the default favicon.
As you describe in the README, I replaced the standard icon with my own one, preserving the name (favicon.ico). Moreover I deleted the apple touch icon file, also modifying partials/favicon-appletouchicon.hbs and deleted the corresponding line.
I restarted the service and deleted the cache. No success.

What am I missing? Is there any other setting that is overriding my modifications?

Misaligned tags

Hello,
grouping posts by tags has a problem.
Here is a screenshot:
steam

I'm using your last version and Ghost 0.8.0.
If you need more information, just let me know.

Bye!

Checklist for v2.0

Ghost 1.0 is on its way and it's time to plan a major revamp of the theme for the big day.
Notably, the two most urgent things to address are code refactoring and new Ghost features.

Being this a fork, it still relies on very old code that was used as a base but never really modified, only overridden. Moreover, while some of the new features of the recent releases of Ghost are kinda useless on this theme, some are not and should be implemented.

I'll keep this issue open with a checklist to prepare for the 2.0 milestone.
Feel free to suggest a feature or report a bug by writing here or opening a new issue.

  • Fix the mess the theme css has become
  • Remove unused fonts and cleanup font families
  • Fix post-author which is currently broken when more than 3 lines are displayed in mobile
  • Add error.hbs to support custom 404 page
  • Show navigation only if active in blog settings
  • Link Facebook and Twitter profile to footer icons
  • Remove extra partials if possible
  • Update external css/js libraries
  • Add all the favicons using something like realfavicongenerator?
  • Add Code of Conduct
  • Add badge for latest Ghost version supported
  • Update installation guide in README to support zip-drop install in admin panel
  • Update package.json to follow the new standard (see Casper)
  • Move CHANGELOG to Keep a Changelog format
  • Add some screenshots both for theme submitting and README
  • Resubmit theme to Ghost Marketplace from which it looks to have been disappeared
  • Add a What's New section in README when releasing v2.0
  • Update demo site to latest Ghost and theme version when releasing v2.0
  • Secure demo site with https

Link previews broken

Link previews when a link is pasted seem to be completely broken:

Screenshot from 2020-04-08 11-01-37

How it should look:

Screenshot from 2020-04-08 11-03-33

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.