search

jshimko / telescope-plugin-hero

A plugin to add a customizable hero banner to your Telescope site.
15 stars 3 forks source link

readme

Telescope Hero Banner Plugin

A simple plugin that lets you add a configurable hero banner to your Telescope site.

Example: http://telescope-hero.meteor.com (you get exactly what you see there simply by adding this package)

Install

meteor add jeremy:telescope-plugin-hero

Customization

Once logged in as an admin, you should see a small tab at the top right of the page that will toggle the hero configuration window. You can configure the background image, main and secondary headings, some additional HTML (appears below the main headings), and some custom CSS.

Note that any styles entered in the custom CSS box can effect the site globally, so make sure to be specific enough with your selectors. Also note that those styles will only be applied on routes where the hero banner is on the page (currently only the post list). And when you turn the hero off with the switch on the overlay, the custom CSS will be disabled as well.

If you'd like to customize the hero with your own CSS, the markup essentially looks like this...

<section class="hero" style="background-image: url('Hero image URL')">
  <div class="hero-inner">
    <div class="copy">
      <h1>Main Heading</h1>
      <h3>Secondary Heading</h3>
      <!-- Extra HTML inserted here -->
    </div>
  </div>
</section>

Future

Feature suggestions and pull requests welcome! Troubles? Drop me a line on Github.