jipiboily / vocal-theme-default

This is Opinionated's default theme

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Vocal's default theme

This is the default theme for Vocal.

Installation

Add this line to your application's Gemfile:

gem 'vocal-theme-default'

And then execute:

$ bundle

Finally, set it as the current theme. To do so, in your Vocal initializer, set:

Vocal.config.theme.name = 'default'
Vocal.config.theme.default.github_url = 'https://github.com/jipiboily'
Vocal.config.theme.default.twitter_url = 'https://twitter.com/jipiboily'
Vocal.config.theme.default.linked_in_url = 'https://www.linkedin.com/in/jipiboily'
Vocal.config.theme.default.google_plus_url = 'https://plus.google.com/+JeanPhilippeBoily'

Customization

You want to customize a few small things? Sure! You can add your own CSS (SASS in fact) or JavaScript (CoffeeScript in fact) by placing those files in your app, they will be picked up by the theme automatically:

  • app/assets/javascripts/vocal/customization.coffee
  • app/assets/stylesheets/vocal/customization.sass

You need something more fancy? You can override any files from this theme, using the exact same path, use Deface or fork the theme and customize it any way you want. For details on how to use Deface with Vocal, see Vocal's README.

Contributing

  1. Fork it ( https://github.com/jipiboily/vocal-theme-default/fork )
  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

About

This is Opinionated's default theme

License:MIT License


Languages

Language:CSS 79.0%Language:Ruby 18.3%Language:CoffeeScript 2.7%