Giter Site home page Giter Site logo

roger_themes's Introduction

RogerThemes

Create themes and release them as static site.

Themes setup

Your themes live in the themes dir, it will release all pages for your themes into the theme dir.

Installation

Add this line to your application's Gemfile:

gem 'roger_themes'

And then execute:

$ bundle

Todo

  • Add tests
  • Complete documentation (especially on how themes work by default)
  • Add theme selector views for usage in table of content

Usage

Include the middleware and processor in the serve and release block:

mockup.serve do |s|
    s.use RogerThemes::Middleware
    # ...
end
mockup.release do |r|
    # ..
    r.use :themes

    # Finalise your zips for XC
    r.finalize RogerThemes::XcFinalizer

Changelog

v0.8.0

  • Make XC zip finalizer contents configurable

v0.7.0

  • Allow config of shard folders in manifest files
  • Allow disabling of shared templates in manifest files
  • Make sure all templates in a theme folder are processed with the theme env variables set.

v0.6.0

  • Attention! env["SITE_THEME"] has been renamed to env["MAIN_THEME"]. Also it will now return a RogerThemes::Theme object instead of a string. The old behaviour can be restored by replacing env["SITE_THEME"] with env["MAIN_THEME"].name
  • Add compatibility for subthemes
  • Add support for manifest files
  • Add datastructures for themes and assets

v0.5.0

  • Make compatible with Roger 1.7

v0.4.0

  • Resolve issue around shared paths (#1)

v0.1.2

  • Fix dir merging when a local folder exists

v0.1.1

  • Update processor

v0.1.0

  • :shared_folders now also takes a hash to enable nested theme folders
      {
          shared_folders: {"images" => "rel/images"}
      }
    
  • Remove rel from shared_folders

v0.0.1 (never released)

  • Initial release

Contributing

  1. Fork it ( https://github.com/digitpaint/roger_themes/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

roger_themes's People

Contributors

edwinvdgraaf avatar hkrutzer avatar

Watchers

Flurin Egger avatar  avatar Danny Cobussen avatar James Cloos avatar Mijke Kosters avatar Youetta avatar  avatar Esmee Peters avatar  avatar  avatar

Forkers

hkrutzer

roger_themes's Issues

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.