RubyGems - luca - Versions diffs - 0.9.8 → 0.9.9 - Mend

luca 0.9.8 → 0.9.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (310) hide show

data/site/DOCS.md ADDED Viewed

@@ -0,0 +1,41 @@
+# Middleman / HTML5 Boilerplate Notes
+Please note that this port of the HTML5 Boilerplate has been converted to use HAML and Sprockets, while using a Middleman 3.x workflow.
+[The original HTML5 Boilerplate documentation](https://github.com/dannyprose/Middleman-HTML5BP-HAML/tree/master/html5bp-docs) is included at /html5bp-docs/ for your reference, but certain things (e.g. ways of including, specific javascript and CSS paths) may be different in our implementation.
+## Recommendations
+* Update `.rvmrc` to the [gemset](https://rvm.io/gemsets/basics/) of your choosing (or remove it if you do not use [RVM](https://rvm.io/))
+* Double check `.gitignore` and make sure it is what you want.
+  * eg: `build/` is ignored by default.
+* If you don't use `middleman init` to load the template, make sure to [use and run Bundler](http://gembundler.com/).
+## Site and Individual Page Titles and Descriptions
+One change we have made from the Boilerplate is some smarter ways of handling site/page titles and descriptions.
+Titles and descriptions are handled 2 ways:
+For the site at large, the title & description is handled through `/helpers/site_helpers.rb`. You can set them there, and the default layout file will include them on every page.
+For individual pages, just add some YAML data to the top of any given page (see our default index for an example):
+```yaml
+---
+title:
+description:
+---
+```
+### Changing the Site Title and Description
+To the change site's title and description, edit the values in `/helpers/site_helpers.rb`. You can also edit the formatting for individual page title and descriptions here.
+To change, individual page's titles and descriptions, see the YAML method above.
+### But I Don't Want This
+No problem - we only included it because we just thought this was a good, DRY use case for Middelman, and it is what the Middleman Docs site uses.
+If you want to develop a method of your own, just remove the `page_title` and `page_description` methods in `/helpers/site_helpers.rb`, remove their references in `/layouts/layout.haml` (all within `<head>`), and restart Middleman. Then do whatever you want to include titles and headers.

data/site/Gemfile ADDED Viewed

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+gem "middleman", "~>3.0.5"
+gem "middleman-favicon-maker"
+gem "middleman-livereload"
+gem "susy", "~>1.0.5"
+gem "redcarpet"
+gem 'ejs'

data/site/Gemfile.lock ADDED Viewed

@@ -0,0 +1,134 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (3.2.12)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    chunky_png (1.2.7)
+    coffee-script (2.2.0)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.3.3)
+    compass (0.12.2)
+      chunky_png (~> 1.2)
+      fssm (>= 0.2.7)
+      sass (~> 3.1)
+    ejs (1.1.1)
+    em-websocket (0.4.0)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0.5.3)
+    eventmachine (1.0.0)
+    execjs (1.4.0)
+      multi_json (~> 1.0)
+    favicon_maker (0.0.9)
+      mini_magick (~> 3.0)
+    ffi (1.4.0)
+    fssm (0.2.10)
+    haml (4.0.0)
+      tilt
+    hike (1.2.1)
+    http_parser.rb (0.5.3)
+    http_router (0.10.2)
+      rack (>= 1.0.0)
+      url_mount (~> 0.2.1)
+    i18n (0.6.1)
+    listen (0.5.3)
+    maruku (0.6.1)
+      syntax (>= 1.0.0)
+    middleman (3.0.11)
+      middleman-core (= 3.0.11)
+      middleman-more (= 3.0.11)
+      middleman-sprockets (~> 3.0.6)
+    middleman-core (3.0.11)
+      activesupport (~> 3.2.6)
+      bundler (~> 1.1)
+      listen (~> 0.5.2)
+      rack (~> 1.4.1)
+      rack-test (~> 0.6.1)
+      rb-fsevent (~> 0.9.1)
+      rb-inotify (~> 0.8.8)
+      thor (~> 0.15.4)
+      tilt (~> 1.3.1)
+    middleman-favicon-maker (3.0.3)
+      favicon_maker (~> 0.0.9)
+      middleman-core (>= 3.0.0)
+    middleman-livereload (3.0.1)
+      em-websocket (>= 0.2.0)
+      middleman-core (~> 3.0.2)
+      multi_json (~> 1.0)
+      rack-livereload
+    middleman-more (3.0.11)
+      coffee-script (~> 2.2.0)
+      coffee-script-source (~> 1.3.3)
+      compass (>= 0.12.2)
+      execjs (~> 1.4.0)
+      haml (>= 3.1.6)
+      i18n (~> 0.6.0)
+      maruku (~> 0.6.0)
+      middleman-core (= 3.0.11)
+      padrino-helpers (= 0.10.7)
+      sass (>= 3.1.20)
+      uglifier (~> 1.2.6)
+    middleman-sprockets (3.0.6)
+      middleman-more (>= 3.0.1)
+      sprockets (~> 2.1, < 2.5)
+      sprockets-sass (~> 0.9.0)
+    mini_magick (3.5.0)
+      subexec (~> 0.2.1)
+    multi_json (1.6.1)
+    padrino-core (0.10.7)
+      activesupport (~> 3.2.0)
+      http_router (~> 0.10.2)
+      sinatra (~> 1.3.1)
+      thor (~> 0.15.2)
+      tilt (~> 1.3.0)
+    padrino-helpers (0.10.7)
+      i18n (~> 0.6)
+      padrino-core (= 0.10.7)
+    rack (1.4.5)
+    rack-livereload (0.3.11)
+      rack
+    rack-protection (1.3.2)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rb-fsevent (0.9.3)
+    rb-inotify (0.8.8)
+      ffi (>= 0.5.0)
+    redcarpet (2.2.2)
+    sass (3.2.5)
+    sinatra (1.3.4)
+      rack (~> 1.4)
+      rack-protection (~> 1.3)
+      tilt (~> 1.3, >= 1.3.3)
+    sprockets (2.4.5)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-sass (0.9.1)
+      sprockets (~> 2.0)
+      tilt (~> 1.1)
+    subexec (0.2.2)
+    susy (1.0.5)
+      compass (>= 0.12.2)
+      sass (>= 3.2.0)
+    syntax (1.0.0)
+    thor (0.15.4)
+    tilt (1.3.3)
+    uglifier (1.2.7)
+      execjs (>= 0.3.0)
+      multi_json (~> 1.3)
+    url_mount (0.2.1)
+      rack
+PLATFORMS
+  ruby
+DEPENDENCIES
+  ejs
+  middleman (~> 3.0.5)
+  middleman-favicon-maker
+  middleman-livereload
+  redcarpet
+  susy (~> 1.0.5)

data/site/LICENSE.md ADDED Viewed

@@ -0,0 +1,19 @@
+Copyright (c) Danny Palmer
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/site/config.rb ADDED Viewed

@@ -0,0 +1,84 @@
+#Markdown
+set :markdown_engine, :redcarpet
+###
+# Compass
+###
+# Susy grids in Compass
+# First: gem install compass-susy-plugin
+# require 'susy'
+# Change Compass configuration
+# compass_config do |config|
+#   config.output_style = :compact
+# end
+###
+# Page options, layouts, aliases and proxies
+###
+page "documentation.html", :layout => false
+# Per-page layout changes:
+#
+# With no layout
+# page "/path/to/file.html", :layout => false
+#
+# With alternative layout
+# page "/path/to/file.html", :layout => :otherlayout
+#
+# A path which all have the same layout
+# with_layout :admin do
+#   page "/admin/*"
+# end
+# Proxy (fake) files
+# page "/this-page-has-no-template.html", :proxy => "/template-file.html" do
+#   @which_fake_page = "Rendering a fake page with a variable"
+# end
+###
+# Helpers
+###
+# Automatic image dimensions on image_tag helper
+# activate :automatic_image_sizes
+# Methods defined in the helpers block are available in templates
+# helpers do
+#   def some_helper
+#     "Helping"
+#   end
+# end
+set :css_dir, 'app/assets/stylesheets'
+set :js_dir, 'app/assets/javascripts'
+set :images_dir, 'app/assets/images'
+# Build-specific configuration
+configure :build do
+  # For example, change the Compass output style for deployment
+  activate :minify_css
+  # Minify Javascript on build
+  activate :minify_javascript
+  # Create favicon/touch icon set from source/favicon_base.png
+  # activate :favicon_maker
+  # Enable cache buster
+  # activate :cache_buster
+  # Use relative URLs
+  activate :relative_assets
+  # Compress PNGs after build
+  # First: gem install middleman-smusher
+  # require "middleman-smusher"
+  # activate :smusher
+  # Or use a different image path
+  # set :http_path, "/Content/images/"
+end

data/site/helpers/site_helpers.rb ADDED Viewed

@@ -0,0 +1,20 @@
+module SiteHelpers
+  def page_title
+    title = "Set your site title in /helpers/site_helpers.rb"
+    if data.page.title
+      title << " | " + data.page.title
+    end
+    title
+  end
+  def page_description
+    if data.page.description
+      description = data.page.description
+    else
+      description = "Set your site description in /helpers/site_helpers.rb"
+    end
+    description
+  end
+end

data/site/html5bp-docs/README.md ADDED Viewed

@@ -0,0 +1,38 @@
+[HTML5 Boilerplate homepage](http://html5boilerplate.com)
+# HTML5 Boilerplate documentation:
+## Getting started
+* [Usage](usage.md) — Overview of the project contents.
+* [FAQ](faq.md) — Frequently asked questions, along with their answers.
+## The core of HTML5 Boilerplate
+* [HTML](html.md) — A guide to the default HTML.
+* [CSS](css.md) — A guide to the default CSS.
+* [JavaScript](js.md) — A guide to the default JavaScript.
+* [.htaccess](htaccess.md) — All about the Apache web server config (also see
+  our [alternative server configs](https://github.com/h5bp/server-configs)).
+* [crossdomain.xml](crossdomain.md) — An introduction to making use of
+  crossdomain requests.
+* [Everything else](misc.md).
+## Development
+* [Contributing to HTML5 Boilerplate](contribute.md) — Guidelines on how to
+  contribute effectively.
+* [Extending and customizing HTML5 Boilerplate](extend.md) — Going further with
+  the boilerplate.
+## Related projects
+HTML5 Boilerplate has several related projects to help improve the performance
+of your site/app in various production environments.
+* [Server configs](https://github.com/h5bp/server-configs) — Configs for
+  non-Apache servers.
+* [Node build script](https://github.com/h5bp/node-build-script) — A
+  feature-rich [grunt](https://github.com/cowboy/grunt) plugin.
+* [Ant build script](https://github.com/h5bp/ant-build-script) — The original
+  HTML5 Boilerplate build script.

data/site/html5bp-docs/contribute.md ADDED Viewed

@@ -0,0 +1,104 @@
+[HTML5 Boilerplate homepage](http://html5boilerplate.com) | [Documentation
+table of contents](README.md)
+# Contributing to HTML5 Boilerplate
+♥ HTML5 Boilerplate and want to get involved? Thanks! There are plenty of ways
+you can help!
+## Reporting issues
+A bug is a _demonstrable problem_ that is caused by the code in the
+repository.
+Please read the following guidelines before you [report an issue](https://github.com/h5bp/html5-boilerplate/issues/):
+1. **Use the GitHub issue search** &mdash; check if the issue has already been
+   reported. If it has been, please comment on the existing issue.
+2. **Check if the issue has been fixed** &mdash; the latest `master` or
+   development branch may already contain a fix.
+3. **Isolate the demonstrable problem** &mdash; make sure that the code in the
+   project's repository is _definitely_ responsible for the issue. Create a
+   [reduced test case](http://css-tricks.com/6263-reduced-test-cases/) - an
+   extremely simple and immediately viewable example of the issue.
+4. **Include a live example** &mdash; provide a link to your reduced test case
+   when appropriate (e.g. if the issue is related to (front-end technologies).
+   Please use [jsFiddle](http://jsfiddle.net) to host examples.
+Please try to be as detailed as possible in your report too. What is your
+environment? What steps will reproduce the issue? What browser(s) and OS
+experience the problem? What would you expect to be the outcome? All these
+details will help people to assess and fix any potential bugs.
+### Example of a good bug report:
+> Short and descriptive title
+>
+> A summary of the issue and the browser/OS environment in which it occurs. If
+> suitable, include the steps required to reproduce the bug.
+>
+> 1. This is the first step
+> 2. This is the second step
+> 3. Further steps, etc.
+>
+> `<url>` (a link to the reduced test case)
+>
+> Any other information you want to share that is relevant to the issue being
+> reported. This might include the lines of code that you have identified as
+> causing the bug, and potential solutions (and your opinions on their
+> merits).
+A good bug report shouldn't leave people needing to chase you up to get further
+information that is required to assess or fix the bug.
+**[File a bug report](https://github.com/h5bp/html5-boilerplate/issues/)**
+## Pull requests
+Good pull requests — patches, improvements, new features — are a fantastic
+help. They should remain focused in scope and avoid containing unrelated
+commits.
+If your contribution involves a significant amount of work or substantial
+changes to any part of the project, please open an issue to discuss it first.
+Please follow this process; it's the best way to get your work included in the
+project:
+1. [Fork](http://help.github.com/fork-a-repo/) the project.
+2. Clone your fork (`git clone
+   https://github.com/<your-username>/html5-boilerplate.git`).
+3. Add an `upstream` remote (`git remote add upstream
+   https://github.com/h5bp/html5-boilerplate.git`).
+4. Get the latest changes from upstream (e.g. `git pull upstream
+   <dev-branch>`).
+5. Create a new topic branch to contain your feature, change, or fix (`git
+   checkout -b <topic-branch-name>`).
+6. Make sure that your changes adhere to the current coding conventions used
+   throughout the project - indentation, accurate comments, etc. Please update
+   any documentation that is relevant to the change you are making.
+7. Commit your changes in logical chunks; use git's [interactive
+   rebase](https://help.github.com/articles/interactive-rebase) feature to tidy
+   up your commits before making them public. Please adhere to these [git commit
+   message
+   guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
+   or your pull request is unlikely be merged into the main project.
+8. Locally merge (or rebase) the upstream branch into your topic branch.
+9. Push your topic branch up to your fork (`git push origin
+   <topic-branch-name>`).
+10. [Open a Pull Request](http://help.github.com/send-pull-requests/) with a
+    clear title and description. Please mention which browsers you tested in.