luca 0.9.89 → 0.9.91

Sign up to get free protection for your applications and to get access to all the features.
Files changed (186) hide show
  1. data/CHANGELOG +11 -1
  2. data/Gemfile +5 -2
  3. data/Gemfile.lock +84 -56
  4. data/Rakefile +10 -2
  5. data/app/assets/javascripts/luca/components/application.coffee +82 -89
  6. data/app/assets/javascripts/luca/components/collection_view.coffee +9 -5
  7. data/app/assets/javascripts/luca/components/controller.coffee +72 -11
  8. data/app/assets/javascripts/luca/components/fields/base.coffee +61 -8
  9. data/app/assets/javascripts/luca/components/fields/button_field.coffee +53 -7
  10. data/app/assets/javascripts/luca/components/fields/checkbox_array.coffee +12 -7
  11. data/app/assets/javascripts/luca/components/fields/text_field.coffee +1 -1
  12. data/app/assets/javascripts/luca/components/form_view.coffee +2 -2
  13. data/app/assets/javascripts/luca/components/grid_layout_view.coffee +0 -1
  14. data/app/assets/javascripts/luca/components/page.coffee +1 -0
  15. data/app/assets/javascripts/luca/components/table_view.coffee +2 -2
  16. data/app/assets/javascripts/luca/concerns/dom_helpers.coffee +2 -2
  17. data/app/assets/javascripts/luca/containers/card_view.coffee +84 -54
  18. data/app/assets/javascripts/luca/containers/container.coffee +126 -46
  19. data/app/assets/javascripts/luca/containers/modal_view.coffee +9 -9
  20. data/app/assets/javascripts/luca/containers/page_controller.coffee +25 -0
  21. data/app/assets/javascripts/luca/containers/panel_toolbar.coffee +1 -1
  22. data/app/assets/javascripts/luca/containers/viewport.coffee +2 -5
  23. data/app/assets/javascripts/luca/core/collection.coffee +18 -4
  24. data/app/assets/javascripts/luca/core/model.coffee +1 -1
  25. data/app/assets/javascripts/luca/core/panel.coffee +1 -1
  26. data/app/assets/javascripts/luca/core/view.coffee +26 -7
  27. data/app/assets/javascripts/luca/development/code_sync_manager.coffee +51 -4
  28. data/app/assets/javascripts/luca/development/console.coffee +1 -1
  29. data/app/assets/javascripts/luca/framework.coffee +1 -1
  30. data/app/assets/javascripts/luca/index.coffee +1 -0
  31. data/app/assets/javascripts/luca/util/luca.coffee +2 -1
  32. data/app/assets/stylesheets/luca/components/viewport.scss +0 -4
  33. data/bin/luca +14 -0
  34. data/docs/framework.json +1 -1
  35. data/docs/luca-framework-documentation.js +1 -0
  36. data/lib/luca/cli/generate.rb +37 -0
  37. data/lib/luca/cli/server.rb +20 -0
  38. data/lib/luca/cli/sync.rb +40 -0
  39. data/lib/luca/cli/watch.rb +16 -0
  40. data/lib/luca/cli.rb +68 -0
  41. data/lib/luca/collection/endpoint.rb +1 -0
  42. data/lib/luca/component_definition.rb +23 -5
  43. data/lib/luca/luca_application.rb +18 -7
  44. data/lib/luca/rails/version.rb +1 -1
  45. data/lib/luca/server.rb +7 -0
  46. data/lib/luca/stylesheet.rb +2 -3
  47. data/lib/luca/version.rb +3 -0
  48. data/lib/luca/watcher.rb +72 -0
  49. data/lib/luca.rb +8 -1
  50. data/luca.gemspec +14 -7
  51. data/site/.bundle/config +2 -0
  52. data/site/.gitignore +5 -0
  53. data/site/.rvmrc +1 -0
  54. data/site/CHANGELOG.md +41 -0
  55. data/site/DOCS.md +41 -0
  56. data/site/Gemfile +8 -0
  57. data/site/Gemfile.lock +134 -0
  58. data/site/LICENSE.md +19 -0
  59. data/site/config.rb +84 -0
  60. data/site/helpers/site_helpers.rb +20 -0
  61. data/site/html5bp-docs/README.md +38 -0
  62. data/site/html5bp-docs/contribute.md +104 -0
  63. data/site/html5bp-docs/crossdomain.md +21 -0
  64. data/site/html5bp-docs/css.md +135 -0
  65. data/site/html5bp-docs/extend.md +507 -0
  66. data/site/html5bp-docs/faq.md +77 -0
  67. data/site/html5bp-docs/htaccess.md +323 -0
  68. data/site/html5bp-docs/html.md +170 -0
  69. data/site/html5bp-docs/js.md +31 -0
  70. data/site/html5bp-docs/misc.md +25 -0
  71. data/site/html5bp-docs/usage.md +109 -0
  72. data/site/readme.md +47 -0
  73. data/site/source/.htaccess +540 -0
  74. data/site/source/404.html +157 -0
  75. data/site/source/app/assets/javascripts/dependencies.js.coffee +6 -0
  76. data/site/source/app/assets/javascripts/docs/application.coffee +64 -0
  77. data/site/source/app/assets/javascripts/docs/collections/docs_documentation.coffee +17 -0
  78. data/site/source/app/assets/javascripts/docs/collections/github_repositories.coffee +7 -0
  79. data/site/source/app/assets/javascripts/docs/collections/index.coffee +1 -0
  80. data/site/source/app/assets/javascripts/docs/collections/luca_documentation.coffee +17 -0
  81. data/site/source/app/assets/javascripts/docs/collections/public_gists.coffee +4 -0
  82. data/site/source/app/assets/javascripts/docs/config.coffee +5 -0
  83. data/site/source/app/assets/javascripts/docs/index.coffee +12 -0
  84. data/site/source/app/assets/javascripts/docs/lib/router.coffee +3 -0
  85. data/site/source/app/assets/javascripts/docs/lib/util.coffee +0 -0
  86. data/site/source/app/assets/javascripts/docs/models/component.coffee +99 -0
  87. data/site/source/app/assets/javascripts/docs/models/github_repository.coffee +3 -0
  88. data/site/source/app/assets/javascripts/docs/models/index.coffee +1 -0
  89. data/site/source/app/assets/javascripts/docs/templates/component_documentation.jst.ejs +55 -0
  90. data/site/source/app/assets/javascripts/docs/templates/examples_browser/overview.jst.ejs +4 -0
  91. data/site/source/app/assets/javascripts/docs/templates/examples_browser/selector.jst.ejs +11 -0
  92. data/site/source/app/assets/javascripts/docs/templates/github_repository.jst.ejs +4 -0
  93. data/site/source/app/assets/javascripts/docs/templates/layouts/main.jst.ejs +4 -0
  94. data/site/source/app/assets/javascripts/docs/templates/left_navigation.jst.ejs +5 -0
  95. data/site/source/app/assets/javascripts/docs/templates/pages/getting_started.jst.ejs +78 -0
  96. data/site/source/app/assets/javascripts/docs/templates/pages/home.jst.ejs +57 -0
  97. data/site/source/app/assets/javascripts/docs/views/components/code_editor/index.coffee +0 -0
  98. data/site/source/app/assets/javascripts/docs/views/components/code_editor.coffee +45 -0
  99. data/site/source/app/assets/javascripts/docs/views/components/component_documentation.coffee +72 -0
  100. data/site/source/app/assets/javascripts/docs/views/index.coffee +3 -0
  101. data/site/source/app/assets/javascripts/docs/views/pages/browse_source/details.coffee +37 -0
  102. data/site/source/app/assets/javascripts/docs/views/pages/browse_source/list.coffee +31 -0
  103. data/site/source/app/assets/javascripts/docs/views/pages/browse_source.coffee +46 -0
  104. data/site/source/app/assets/javascripts/docs/views/pages/component_editor.coffee +10 -0
  105. data/site/source/app/assets/javascripts/docs/views/pages/examples_browser/docs.coffee +12 -0
  106. data/site/source/app/assets/javascripts/docs/views/pages/examples_browser/source.coffee +13 -0
  107. data/site/source/app/assets/javascripts/docs/views/pages/examples_browser.coffee +102 -0
  108. data/site/source/app/assets/javascripts/docs/views/pages/home.coffee +10 -0
  109. data/site/source/app/assets/javascripts/docs/views/views/api_browser/index.coffee +43 -0
  110. data/site/source/app/assets/javascripts/docs/views/views/collection_view_examples/grid_layout_view_example.coffee +14 -0
  111. data/site/source/app/assets/javascripts/docs/views/views/collection_view_examples/table_view_example.coffee +39 -0
  112. data/site/source/app/assets/javascripts/docs/views/views/form_view_examples/basic_example.coffee +38 -0
  113. data/site/source/app/assets/javascripts/docs/views/views/form_view_examples/complex_layout.coffee +110 -0
  114. data/site/source/app/assets/javascripts/docs/views/views/top_navigation.coffee +6 -0
  115. data/site/source/app/assets/javascripts/docs-docs.js +1 -0
  116. data/site/source/app/assets/javascripts/luca-docs.js +1 -0
  117. data/site/source/app/assets/javascripts/luca-framework-documentation.js +1 -0
  118. data/site/source/app/assets/javascripts/site.js.coffee +4 -0
  119. data/site/source/app/assets/javascripts/vendor/codemirror.js +4786 -0
  120. data/site/source/app/assets/javascripts/vendor/coffeescript.js +346 -0
  121. data/site/source/app/assets/javascripts/vendor/css.js +465 -0
  122. data/site/source/app/assets/javascripts/vendor/htmlmixed.js +84 -0
  123. data/site/source/app/assets/javascripts/vendor/javascript.js +422 -0
  124. data/site/source/app/assets/javascripts/vendor/js-beautify.js +1353 -0
  125. data/site/source/app/assets/javascripts/vendor/modernizr-2.6.1.min.js +4 -0
  126. data/site/source/app/assets/javascripts/vendor/vim.js +2511 -0
  127. data/site/source/app/assets/stylesheets/docs/api-browser.css.scss +5 -0
  128. data/site/source/app/assets/stylesheets/docs/application.css.scss +35 -0
  129. data/site/source/app/assets/stylesheets/docs/browse-source.css.scss +5 -0
  130. data/site/source/app/assets/stylesheets/docs/scrollable-table.css.scss +5 -0
  131. data/site/source/app/assets/stylesheets/site.css.scss +2 -0
  132. data/site/source/app/assets/stylesheets/vendor/codemirror.css +240 -0
  133. data/site/source/app/assets/stylesheets/vendor/prettify-tomorrow-night-bright.css +160 -0
  134. data/site/source/app/assets/stylesheets/vendor/twilight.css +26 -0
  135. data/site/source/crossdomain.xml +15 -0
  136. data/site/source/documentation.html.haml +1 -0
  137. data/site/source/favicon_base.png +0 -0
  138. data/site/source/humans.txt +15 -0
  139. data/site/source/images/background.png +0 -0
  140. data/site/source/images/middleman.png +0 -0
  141. data/site/source/index.html.haml +1 -0
  142. data/site/source/layouts/layout.haml +55 -0
  143. data/site/source/readme.md +63 -0
  144. data/site/source/robots.txt +3 -0
  145. data/spec/javascripts/components/collection_view_spec.coffee +1 -1
  146. data/spec/javascripts/containers/card_view_spec.coffee +58 -5
  147. data/spec/javascripts/core/collection_spec.coffee +1 -1
  148. data/spec/javascripts/core/view_spec.coffee +2 -2
  149. data/vendor/assets/javascripts/backbone-min.js +37 -33
  150. data/vendor/assets/javascripts/backbone-query.min.js +1 -1
  151. data/vendor/assets/javascripts/jquery.js +5 -4
  152. data/vendor/assets/javascripts/luca-dependencies.min.js +8 -6
  153. data/vendor/assets/javascripts/luca-development.min.js +1 -1
  154. data/vendor/assets/javascripts/luca.full.min.js +12 -10
  155. data/vendor/assets/javascripts/luca.min.js +5 -5
  156. data/vendor/assets/javascripts/underscore-min.js +1 -5
  157. data/vendor/assets/javascripts/underscore-string.min.js +1 -1
  158. data/vendor/assets/stylesheets/luca-components.css +0 -2
  159. data/vendor/assets/stylesheets/luca-development.css +1 -1
  160. metadata +215 -39
  161. data/app/assets/javascripts/luca/components/page_controller.coffee +0 -3
  162. data/app/assets/javascripts/luca/core/collection_view.coffee +0 -150
  163. data/site/assets/bootstrap.min.js +0 -7
  164. data/site/assets/dependencies.js +0 -94
  165. data/site/assets/glyphicons-halflings-white.png +0 -0
  166. data/site/assets/glyphicons-halflings.png +0 -0
  167. data/site/assets/luca-ui-bootstrap.css +0 -1331
  168. data/site/assets/luca-ui-bootstrap.js +0 -9
  169. data/site/assets/luca-ui-development-tools.css +0 -234
  170. data/site/assets/luca-ui-development-tools.js +0 -18561
  171. data/site/assets/luca-ui-development-tools.min.js +0 -15
  172. data/site/assets/luca-ui-full.min.js +0 -8
  173. data/site/assets/luca-ui.min.js +0 -4
  174. data/site/assets/sandbox.css +0 -62
  175. data/site/assets/sandbox.js +0 -469
  176. data/site/docs/application.html +0 -41
  177. data/site/docs/caching.html +0 -43
  178. data/site/docs/collection.html +0 -75
  179. data/site/docs/collection_manager.html +0 -71
  180. data/site/docs/containers.html +0 -118
  181. data/site/docs/events.html +0 -153
  182. data/site/docs/view.html +0 -128
  183. data/site/img/glyphicons-halflings-white.png +0 -0
  184. data/site/img/glyphicons-halflings.png +0 -0
  185. data/site/index.html +0 -20
  186. data/site/source-map.js +0 -1
data/site/Gemfile.lock ADDED
@@ -0,0 +1,134 @@
1
+ GEM
2
+ remote: https://rubygems.org/
3
+ specs:
4
+ activesupport (3.2.12)
5
+ i18n (~> 0.6)
6
+ multi_json (~> 1.0)
7
+ chunky_png (1.2.7)
8
+ coffee-script (2.2.0)
9
+ coffee-script-source
10
+ execjs
11
+ coffee-script-source (1.3.3)
12
+ compass (0.12.2)
13
+ chunky_png (~> 1.2)
14
+ fssm (>= 0.2.7)
15
+ sass (~> 3.1)
16
+ ejs (1.1.1)
17
+ em-websocket (0.4.0)
18
+ eventmachine (>= 0.12.9)
19
+ http_parser.rb (~> 0.5.3)
20
+ eventmachine (1.0.0)
21
+ execjs (1.4.0)
22
+ multi_json (~> 1.0)
23
+ favicon_maker (0.0.9)
24
+ mini_magick (~> 3.0)
25
+ ffi (1.4.0)
26
+ fssm (0.2.10)
27
+ haml (4.0.0)
28
+ tilt
29
+ hike (1.2.1)
30
+ http_parser.rb (0.5.3)
31
+ http_router (0.10.2)
32
+ rack (>= 1.0.0)
33
+ url_mount (~> 0.2.1)
34
+ i18n (0.6.1)
35
+ listen (0.5.3)
36
+ maruku (0.6.1)
37
+ syntax (>= 1.0.0)
38
+ middleman (3.0.11)
39
+ middleman-core (= 3.0.11)
40
+ middleman-more (= 3.0.11)
41
+ middleman-sprockets (~> 3.0.6)
42
+ middleman-core (3.0.11)
43
+ activesupport (~> 3.2.6)
44
+ bundler (~> 1.1)
45
+ listen (~> 0.5.2)
46
+ rack (~> 1.4.1)
47
+ rack-test (~> 0.6.1)
48
+ rb-fsevent (~> 0.9.1)
49
+ rb-inotify (~> 0.8.8)
50
+ thor (~> 0.15.4)
51
+ tilt (~> 1.3.1)
52
+ middleman-favicon-maker (3.0.3)
53
+ favicon_maker (~> 0.0.9)
54
+ middleman-core (>= 3.0.0)
55
+ middleman-livereload (3.0.1)
56
+ em-websocket (>= 0.2.0)
57
+ middleman-core (~> 3.0.2)
58
+ multi_json (~> 1.0)
59
+ rack-livereload
60
+ middleman-more (3.0.11)
61
+ coffee-script (~> 2.2.0)
62
+ coffee-script-source (~> 1.3.3)
63
+ compass (>= 0.12.2)
64
+ execjs (~> 1.4.0)
65
+ haml (>= 3.1.6)
66
+ i18n (~> 0.6.0)
67
+ maruku (~> 0.6.0)
68
+ middleman-core (= 3.0.11)
69
+ padrino-helpers (= 0.10.7)
70
+ sass (>= 3.1.20)
71
+ uglifier (~> 1.2.6)
72
+ middleman-sprockets (3.0.6)
73
+ middleman-more (>= 3.0.1)
74
+ sprockets (~> 2.1, < 2.5)
75
+ sprockets-sass (~> 0.9.0)
76
+ mini_magick (3.5.0)
77
+ subexec (~> 0.2.1)
78
+ multi_json (1.6.1)
79
+ padrino-core (0.10.7)
80
+ activesupport (~> 3.2.0)
81
+ http_router (~> 0.10.2)
82
+ sinatra (~> 1.3.1)
83
+ thor (~> 0.15.2)
84
+ tilt (~> 1.3.0)
85
+ padrino-helpers (0.10.7)
86
+ i18n (~> 0.6)
87
+ padrino-core (= 0.10.7)
88
+ rack (1.4.5)
89
+ rack-livereload (0.3.11)
90
+ rack
91
+ rack-protection (1.3.2)
92
+ rack
93
+ rack-test (0.6.2)
94
+ rack (>= 1.0)
95
+ rb-fsevent (0.9.3)
96
+ rb-inotify (0.8.8)
97
+ ffi (>= 0.5.0)
98
+ redcarpet (2.2.2)
99
+ sass (3.2.5)
100
+ sinatra (1.3.4)
101
+ rack (~> 1.4)
102
+ rack-protection (~> 1.3)
103
+ tilt (~> 1.3, >= 1.3.3)
104
+ sprockets (2.4.5)
105
+ hike (~> 1.2)
106
+ multi_json (~> 1.0)
107
+ rack (~> 1.0)
108
+ tilt (~> 1.1, != 1.3.0)
109
+ sprockets-sass (0.9.1)
110
+ sprockets (~> 2.0)
111
+ tilt (~> 1.1)
112
+ subexec (0.2.2)
113
+ susy (1.0.5)
114
+ compass (>= 0.12.2)
115
+ sass (>= 3.2.0)
116
+ syntax (1.0.0)
117
+ thor (0.15.4)
118
+ tilt (1.3.3)
119
+ uglifier (1.2.7)
120
+ execjs (>= 0.3.0)
121
+ multi_json (~> 1.3)
122
+ url_mount (0.2.1)
123
+ rack
124
+
125
+ PLATFORMS
126
+ ruby
127
+
128
+ DEPENDENCIES
129
+ ejs
130
+ middleman (~> 3.0.5)
131
+ middleman-favicon-maker
132
+ middleman-livereload
133
+ redcarpet
134
+ susy (~> 1.0.5)
data/site/LICENSE.md ADDED
@@ -0,0 +1,19 @@
1
+ Copyright (c) Danny Palmer
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining a copy of
4
+ this software and associated documentation files (the "Software"), to deal in
5
+ the Software without restriction, including without limitation the rights to
6
+ use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
7
+ of the Software, and to permit persons to whom the Software is furnished to do
8
+ so, subject to the following conditions:
9
+
10
+ The above copyright notice and this permission notice shall be included in all
11
+ copies or substantial portions of the Software.
12
+
13
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19
+ SOFTWARE.
data/site/config.rb ADDED
@@ -0,0 +1,84 @@
1
+ #Markdown
2
+ set :markdown_engine, :redcarpet
3
+
4
+ ###
5
+ # Compass
6
+ ###
7
+
8
+ # Susy grids in Compass
9
+ # First: gem install compass-susy-plugin
10
+ # require 'susy'
11
+
12
+ # Change Compass configuration
13
+ # compass_config do |config|
14
+ # config.output_style = :compact
15
+ # end
16
+
17
+ ###
18
+ # Page options, layouts, aliases and proxies
19
+ ###
20
+
21
+ page "documentation.html", :layout => false
22
+ # Per-page layout changes:
23
+ #
24
+ # With no layout
25
+ # page "/path/to/file.html", :layout => false
26
+ #
27
+ # With alternative layout
28
+ # page "/path/to/file.html", :layout => :otherlayout
29
+ #
30
+ # A path which all have the same layout
31
+ # with_layout :admin do
32
+ # page "/admin/*"
33
+ # end
34
+
35
+ # Proxy (fake) files
36
+ # page "/this-page-has-no-template.html", :proxy => "/template-file.html" do
37
+ # @which_fake_page = "Rendering a fake page with a variable"
38
+ # end
39
+
40
+ ###
41
+ # Helpers
42
+ ###
43
+
44
+ # Automatic image dimensions on image_tag helper
45
+ # activate :automatic_image_sizes
46
+
47
+ # Methods defined in the helpers block are available in templates
48
+ # helpers do
49
+ # def some_helper
50
+ # "Helping"
51
+ # end
52
+ # end
53
+
54
+ set :css_dir, 'app/assets/stylesheets'
55
+
56
+ set :js_dir, 'app/assets/javascripts'
57
+
58
+ set :images_dir, 'app/assets/images'
59
+
60
+ # Build-specific configuration
61
+ configure :build do
62
+ # For example, change the Compass output style for deployment
63
+ activate :minify_css
64
+
65
+ # Minify Javascript on build
66
+ activate :minify_javascript
67
+
68
+ # Create favicon/touch icon set from source/favicon_base.png
69
+ # activate :favicon_maker
70
+
71
+ # Enable cache buster
72
+ # activate :cache_buster
73
+
74
+ # Use relative URLs
75
+ activate :relative_assets
76
+
77
+ # Compress PNGs after build
78
+ # First: gem install middleman-smusher
79
+ # require "middleman-smusher"
80
+ # activate :smusher
81
+
82
+ # Or use a different image path
83
+ # set :http_path, "/Content/images/"
84
+ end
@@ -0,0 +1,20 @@
1
+ module SiteHelpers
2
+
3
+ def page_title
4
+ title = "Set your site title in /helpers/site_helpers.rb"
5
+ if data.page.title
6
+ title << " | " + data.page.title
7
+ end
8
+ title
9
+ end
10
+
11
+ def page_description
12
+ if data.page.description
13
+ description = data.page.description
14
+ else
15
+ description = "Set your site description in /helpers/site_helpers.rb"
16
+ end
17
+ description
18
+ end
19
+
20
+ end
@@ -0,0 +1,38 @@
1
+ [HTML5 Boilerplate homepage](http://html5boilerplate.com)
2
+
3
+ # HTML5 Boilerplate documentation:
4
+
5
+ ## Getting started
6
+
7
+ * [Usage](usage.md) — Overview of the project contents.
8
+ * [FAQ](faq.md) — Frequently asked questions, along with their answers.
9
+
10
+ ## The core of HTML5 Boilerplate
11
+
12
+ * [HTML](html.md) — A guide to the default HTML.
13
+ * [CSS](css.md) — A guide to the default CSS.
14
+ * [JavaScript](js.md) — A guide to the default JavaScript.
15
+ * [.htaccess](htaccess.md) — All about the Apache web server config (also see
16
+ our [alternative server configs](https://github.com/h5bp/server-configs)).
17
+ * [crossdomain.xml](crossdomain.md) — An introduction to making use of
18
+ crossdomain requests.
19
+ * [Everything else](misc.md).
20
+
21
+ ## Development
22
+
23
+ * [Contributing to HTML5 Boilerplate](contribute.md) — Guidelines on how to
24
+ contribute effectively.
25
+ * [Extending and customizing HTML5 Boilerplate](extend.md) — Going further with
26
+ the boilerplate.
27
+
28
+ ## Related projects
29
+
30
+ HTML5 Boilerplate has several related projects to help improve the performance
31
+ of your site/app in various production environments.
32
+
33
+ * [Server configs](https://github.com/h5bp/server-configs) — Configs for
34
+ non-Apache servers.
35
+ * [Node build script](https://github.com/h5bp/node-build-script) — A
36
+ feature-rich [grunt](https://github.com/cowboy/grunt) plugin.
37
+ * [Ant build script](https://github.com/h5bp/ant-build-script) — The original
38
+ HTML5 Boilerplate build script.
@@ -0,0 +1,104 @@
1
+ [HTML5 Boilerplate homepage](http://html5boilerplate.com) | [Documentation
2
+ table of contents](README.md)
3
+
4
+ # Contributing to HTML5 Boilerplate
5
+
6
+ ♥ HTML5 Boilerplate and want to get involved? Thanks! There are plenty of ways
7
+ you can help!
8
+
9
+
10
+ ## Reporting issues
11
+
12
+ A bug is a _demonstrable problem_ that is caused by the code in the
13
+ repository.
14
+
15
+ Please read the following guidelines before you [report an issue](https://github.com/h5bp/html5-boilerplate/issues/):
16
+
17
+ 1. **Use the GitHub issue search** &mdash; check if the issue has already been
18
+ reported. If it has been, please comment on the existing issue.
19
+
20
+ 2. **Check if the issue has been fixed** &mdash; the latest `master` or
21
+ development branch may already contain a fix.
22
+
23
+ 3. **Isolate the demonstrable problem** &mdash; make sure that the code in the
24
+ project's repository is _definitely_ responsible for the issue. Create a
25
+ [reduced test case](http://css-tricks.com/6263-reduced-test-cases/) - an
26
+ extremely simple and immediately viewable example of the issue.
27
+
28
+ 4. **Include a live example** &mdash; provide a link to your reduced test case
29
+ when appropriate (e.g. if the issue is related to (front-end technologies).
30
+ Please use [jsFiddle](http://jsfiddle.net) to host examples.
31
+
32
+ Please try to be as detailed as possible in your report too. What is your
33
+ environment? What steps will reproduce the issue? What browser(s) and OS
34
+ experience the problem? What would you expect to be the outcome? All these
35
+ details will help people to assess and fix any potential bugs.
36
+
37
+ ### Example of a good bug report:
38
+
39
+ > Short and descriptive title
40
+ >
41
+ > A summary of the issue and the browser/OS environment in which it occurs. If
42
+ > suitable, include the steps required to reproduce the bug.
43
+ >
44
+ > 1. This is the first step
45
+ > 2. This is the second step
46
+ > 3. Further steps, etc.
47
+ >
48
+ > `<url>` (a link to the reduced test case)
49
+ >
50
+ > Any other information you want to share that is relevant to the issue being
51
+ > reported. This might include the lines of code that you have identified as
52
+ > causing the bug, and potential solutions (and your opinions on their
53
+ > merits).
54
+
55
+ A good bug report shouldn't leave people needing to chase you up to get further
56
+ information that is required to assess or fix the bug.
57
+
58
+ **[File a bug report](https://github.com/h5bp/html5-boilerplate/issues/)**
59
+
60
+
61
+ ## Pull requests
62
+
63
+ Good pull requests — patches, improvements, new features — are a fantastic
64
+ help. They should remain focused in scope and avoid containing unrelated
65
+ commits.
66
+
67
+ If your contribution involves a significant amount of work or substantial
68
+ changes to any part of the project, please open an issue to discuss it first.
69
+
70
+ Please follow this process; it's the best way to get your work included in the
71
+ project:
72
+
73
+ 1. [Fork](http://help.github.com/fork-a-repo/) the project.
74
+
75
+ 2. Clone your fork (`git clone
76
+ https://github.com/<your-username>/html5-boilerplate.git`).
77
+
78
+ 3. Add an `upstream` remote (`git remote add upstream
79
+ https://github.com/h5bp/html5-boilerplate.git`).
80
+
81
+ 4. Get the latest changes from upstream (e.g. `git pull upstream
82
+ <dev-branch>`).
83
+
84
+ 5. Create a new topic branch to contain your feature, change, or fix (`git
85
+ checkout -b <topic-branch-name>`).
86
+
87
+ 6. Make sure that your changes adhere to the current coding conventions used
88
+ throughout the project - indentation, accurate comments, etc. Please update
89
+ any documentation that is relevant to the change you are making.
90
+
91
+ 7. Commit your changes in logical chunks; use git's [interactive
92
+ rebase](https://help.github.com/articles/interactive-rebase) feature to tidy
93
+ up your commits before making them public. Please adhere to these [git commit
94
+ message
95
+ guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
96
+ or your pull request is unlikely be merged into the main project.
97
+
98
+ 8. Locally merge (or rebase) the upstream branch into your topic branch.
99
+
100
+ 9. Push your topic branch up to your fork (`git push origin
101
+ <topic-branch-name>`).
102
+
103
+ 10. [Open a Pull Request](http://help.github.com/send-pull-requests/) with a
104
+ clear title and description. Please mention which browsers you tested in.
@@ -0,0 +1,21 @@
1
+ [HTML5 Boilerplate homepage](http://html5boilerplate.com) | [Documentation
2
+ table of contents](README.md)
3
+
4
+ # crossdomain.xml
5
+
6
+ A cross-domain policy file is an XML document that grants a web client—such as
7
+ Adobe Flash Player, Adobe Reader, etc., permission to handle data across
8
+ multiple domains. When a client hosts content from a particular source domain
9
+ and that content makes requests directed towards a domain other than its own,
10
+ the remote domain would need to host a cross-domain policy file that grants
11
+ access to the source domain, allowing the client to continue with the
12
+ transaction. Policy files grant read access to data, permit a client to include
13
+ custom headers in cross-domain requests, and are also used with sockets to
14
+ grant permissions for socket-based connections.
15
+
16
+ For full details, check out Adobe's article about the [cross-domain policy file
17
+ specification](http://www.adobe.com/devnet/articles/crossdomain_policy_file_spec.html)
18
+
19
+ Read the [Cross-domain policy file
20
+ specification](http://learn.adobe.com/wiki/download/attachments/64389123/CrossDomain_PolicyFile_Specification.pdf?version=1)
21
+ - (PDF, 129 KB)
@@ -0,0 +1,135 @@
1
+ [HTML5 Boilerplate homepage](http://html5boilerplate.com) | [Documentation
2
+ table of contents](README.md)
3
+
4
+ # The CSS
5
+
6
+ The HTML5 Boilerplate starting CSS includes:
7
+
8
+ * [Normalize.css](https://github.com/necolas/normalize.css).
9
+ * Useful HTML5 Boilerplate defaults.
10
+ * Common helpers.
11
+ * Placeholder media queries.
12
+ * Print styles.
13
+
14
+ This starting CSS does not rely on the presence of conditional classnames,
15
+ conditional style sheets, or Modernizr. It is ready to use whatever your
16
+ development preferences happen to be.
17
+
18
+
19
+ ## Normalize.css
20
+
21
+ Normalize.css is a modern, HTML5-ready alternative to CSS resets. It contains
22
+ extensive inline documentation. Please refer to the [Normalize.css
23
+ project](http://necolas.github.com/normalize.css/) for more information.
24
+
25
+
26
+ ## HTML5 Boilerplate defaults
27
+
28
+ This project includes a handful of base styles that build upon Normalize.css.
29
+ These include:
30
+
31
+ * Basic typography settings to provide improved text readability by default.
32
+ * Protection against unwanted `text-shadow` during text highlighting.
33
+ * Tweaks to default image alignment, fieldsets, and textareas.
34
+ * A pretty Chrome Frame prompt.
35
+
36
+ You are free to modify or add to these base styles as your project requires.
37
+
38
+
39
+ ## Common helpers
40
+
41
+ #### `.ir`
42
+
43
+ Add the `.ir` class to any element you are applying image-replacement to. When
44
+ replacing an element's content with an image, make sure to also set a specific
45
+ `background-image: url(pathtoimage.png);`, `width`, and `height` so that your
46
+ replacement image appears.
47
+
48
+ #### `.hidden`
49
+
50
+ Add the `.hidden` class to any elements that you want to hide from all
51
+ presentations, including screen readers. It could be an element that will be
52
+ populated later with JavaScript or an element you will hide with JavaScript. Do
53
+ not use this for SEO keyword stuffing. That is just not cool.
54
+
55
+ #### `.visuallyhidden`
56
+
57
+ Add the `.visuallyhidden` class to hide text from browsers but make it
58
+ available for screen readers. You can use this to hide text that is specific to
59
+ screen readers but that other users should not see. [About invisible
60
+ content](http://www.webaim.org/techniques/css/invisiblecontent/), [Hiding
61
+ content for
62
+ accessibility](http://snook.ca/archives/html_and_css/hiding-content-for-accessibility),
63
+ [HTML5 Boilerplate
64
+ issue/research](https://github.com/h5bp/html5-boilerplate/issues/194/).
65
+
66
+ #### `.invisible`
67
+
68
+ Add the `.invisible` class to any element you want to hide without affecting
69
+ layout. When you use `display: none` an element is effectively removed from the
70
+ layout. But in some cases you want the element to simply be invisible while
71
+ remaining in the flow and not affecting the positioning of surrounding
72
+ content.
73
+
74
+ #### `.clearfix`
75
+
76
+ Adding `.clearfix` to an element will ensure that it always fully contains its
77
+ floated children. There have been many variants of the clearfix hack over the
78
+ years, and there are other hacks that can also help you to contain floated
79
+ children, but the HTML5 Boilerplate currently uses the [micro
80
+ clearfix](http://nicolasgallagher.com/micro-clearfix-hack/).
81
+
82
+
83
+ ## Media Queries
84
+
85
+ The boilerplate makes it easy to get started with a "Mobile First" and
86
+ [Responsive Web
87
+ Design](http://www.alistapart.com/articles/responsive-web-design/) approach to
88
+ development. But it's worth remembering that there are [no silver
89
+ bullets](http://www.cloudfour.com/css-media-query-for-mobile-is-fools-gold/).
90
+
91
+ We include a placeholder Media Queries to build up your mobile styles for wider
92
+ viewports and high-resolution displays. It's recommended that you adapt these
93
+ Media Queries based on the content of your site rather than mirroring the fixed
94
+ dimensions of specific devices.
95
+
96
+ If you do not want to take a "Mobile First" approach, you can simply edit or
97
+ remove these placeholder Media Queries. One possibility would be to work from
98
+ wide viewports down and use `max-width` MQs instead, e.g., `@media only screen
99
+ and (max-width: 480px)`.
100
+
101
+ Take a look into the [Mobile
102
+ Boilerplate](https://github.com/h5bp/mobile-boilerplate) for features that are
103
+ useful when developing mobile wep apps.
104
+
105
+
106
+ ## Print styles
107
+
108
+ * Print styles are inlined to [reduce the number of page
109
+ requests](http://www.phpied.com/delay-loading-your-print-css/).
110
+ * We strip all background colors and change the font color to dark gray and
111
+ remove text-shadow. This is meant to help save printer ink.
112
+ * Anchors do not need colors to indicate they are linked. They are underlined
113
+ to indicate so.
114
+ * Anchors and Abbreviations are expanded to indicate where users reading the
115
+ printed page can refer to.
116
+ * But we do not want to show link text for image replaced elements (given that
117
+ they are primarily images).
118
+
119
+ ### Paged media styles
120
+
121
+ * Paged media is supported only in a [few
122
+ browsers](http://en.wikipedia.org/wiki/Comparison_of_layout_engines_%28Cascading_Style_Sheets%29#Grammar_and_rules).
123
+ * Paged media support means browsers would know how to interpret instructions
124
+ on breaking content into pages and on orphans/widows.
125
+ * We use `page-break-inside: avoid;` to prevent an image and table row from
126
+ being split into two different pages, so use the same `page-break-inside:
127
+ avoid;` for that as well.
128
+ * Headings should always appear with the text they are titles for. So, we
129
+ ensure headings never appear in a different page than the text they describe
130
+ by using `page-break-after: avoid;`.
131
+ * We also apply a default margin for the page specified in `cm`.
132
+ * We do not want [orphans and
133
+ widows](http://en.wikipedia.org/wiki/Widows_and_orphans) to appear on pages
134
+ you print. So, by defining `orphans: 3` and `widows: 3` you define the minimal
135
+ number of words that every line should contain.