luca 0.9.9 → 0.9.42
Sign up to get free protection for your applications and to get access to all the features.
- data/CHANGELOG +9 -153
- data/Gemfile +1 -10
- data/Gemfile.lock +40 -113
- data/Guardfile +25 -3
- data/README.md +57 -54
- data/ROADMAP +32 -15
- data/Rakefile +75 -24
- data/app.rb +46 -12
- data/{app/assets → assets}/images/glyphicons-halflings-white.png +0 -0
- data/{app/assets → assets}/images/glyphicons-halflings.png +0 -0
- data/assets/javascripts/dependencies/backbone-min.js +37 -0
- data/assets/javascripts/dependencies/backbone-query.min.js +1 -0
- data/assets/javascripts/dependencies/bootstrap.min.js +7 -0
- data/{vendor/assets/javascripts → assets/javascripts/dependencies}/codemirror-coffeescript.js +0 -0
- data/{vendor/assets/javascripts → assets/javascripts/dependencies}/codemirror-css.js +0 -0
- data/{vendor/assets/javascripts → assets/javascripts/dependencies}/codemirror-html.js +0 -0
- data/{vendor/assets/javascripts → assets/javascripts/dependencies}/codemirror-javascript.js +0 -0
- data/{vendor/assets/javascripts → assets/javascripts/dependencies}/codemirror-less.js +0 -0
- data/{vendor/assets/javascripts → assets/javascripts/dependencies}/codemirror-vim.js +0 -0
- data/{vendor/assets/javascripts → assets/javascripts/dependencies}/codemirror.js +0 -0
- data/assets/javascripts/dependencies/coffee-script.js +12189 -0
- data/{spec → assets}/javascripts/dependencies/jasmine-html.js +0 -0
- data/{spec → assets}/javascripts/dependencies/jasmine.js +0 -0
- data/assets/javascripts/dependencies/jquery.js +4 -0
- data/{vendor/assets/javascripts → assets/javascripts/dependencies}/modal.js +0 -0
- data/{vendor/assets/javascripts → assets/javascripts/dependencies}/modernizr.min.js +0 -0
- data/{vendor/assets/javascripts → assets/javascripts/dependencies}/prettify.js +0 -0
- data/{spec → assets}/javascripts/dependencies/sinon.js +0 -0
- data/{vendor/assets/javascripts → assets/javascripts/dependencies}/spin-min.js +0 -0
- data/assets/javascripts/dependencies/underscore-min.js +31 -0
- data/assets/javascripts/dependencies/underscore-string.min.js +14 -0
- data/assets/javascripts/dependencies.coffee +5 -0
- data/assets/javascripts/luca/index.coffee +1 -0
- data/assets/javascripts/luca-templates.js +1 -0
- data/assets/javascripts/luca-ui-base.coffee +1 -0
- data/assets/javascripts/luca-ui-bootstrap.js +1 -0
- data/assets/javascripts/luca-ui-development-tools.coffee +9 -0
- data/assets/javascripts/luca-ui-full.js +3 -0
- data/assets/javascripts/luca-ui-spec.coffee +2 -0
- data/assets/javascripts/luca-ui.js +3 -0
- data/assets/javascripts/sandbox/application.coffee +57 -0
- data/assets/javascripts/sandbox/config.coffee +7 -0
- data/assets/javascripts/sandbox/router.coffee +24 -0
- data/assets/javascripts/sandbox/templates/builder/component_list.luca +1 -0
- data/assets/javascripts/sandbox/templates/builder.luca +2 -0
- data/assets/javascripts/sandbox/templates/main.luca +53 -0
- data/assets/javascripts/sandbox/templates/sandbox/docs_index.luca +1 -0
- data/assets/javascripts/sandbox/templates/sandbox/navigation.luca +8 -0
- data/assets/javascripts/sandbox/templates/sandbox/readme.luca +30 -0
- data/assets/javascripts/sandbox/templates/sandbox.luca +1 -0
- data/assets/javascripts/sandbox/views/builder/builder_canvas.coffee +3 -0
- data/assets/javascripts/sandbox/views/builder/builder_editor.coffee +6 -0
- data/assets/javascripts/sandbox/views/builder/component_list.coffee +38 -0
- data/assets/javascripts/sandbox/views/builder/project_browser.coffee +14 -0
- data/assets/javascripts/sandbox/views/builder.coffee +133 -0
- data/assets/javascripts/sandbox/views/docs_controller.coffee +7 -0
- data/assets/javascripts/sandbox/views/inspector/instance_filter.coffee +18 -0
- data/{app/assets/stylesheets/luca/containers/modal_view.scss → assets/javascripts/sandbox/views/inspector/instance_list.coffee} +0 -0
- data/assets/javascripts/sandbox/views/inspector.coffee +11 -0
- data/assets/javascripts/sandbox/views/top_navigation.coffee +4 -0
- data/assets/javascripts/sandbox.coffee +7 -0
- data/assets/javascripts/spec-dependencies.coffee +4 -0
- data/assets/stylesheets/bootstrap-responsive.min.css +2 -0
- data/assets/stylesheets/bootstrap.min.css +727 -0
- data/{vendor/assets → assets}/stylesheets/codemirror-blackboard.css +0 -0
- data/{vendor/assets → assets}/stylesheets/codemirror-monokai.css +0 -0
- data/{vendor/assets → assets}/stylesheets/codemirror.css +0 -0
- data/{vendor/assets → assets}/stylesheets/jasmine.css +0 -0
- data/assets/stylesheets/luca-ui-bootstrap.css +4 -0
- data/assets/stylesheets/luca-ui-development-tools.css +5 -0
- data/assets/stylesheets/luca-ui-full.css +3 -0
- data/assets/stylesheets/luca-ui-spec.css +3 -0
- data/assets/stylesheets/luca-ui.css +3 -0
- data/assets/stylesheets/prettify.css +40 -0
- data/assets/stylesheets/sandbox/builder.scss +79 -0
- data/assets/stylesheets/sandbox/sandbox.scss +18 -0
- data/assets/stylesheets/sandbox.css +3 -0
- data/assets/stylesheets/themes/amelia-bootstrap.css +826 -0
- data/assets/stylesheets/themes/slate-bootstrap.css +797 -0
- data/assets/stylesheets/themes/superhero-bootstrap.css +830 -0
- data/config.ru +2 -1
- data/docs/{old/application.md → application.md} +0 -0
- data/docs/{old/collection.md → collection.md} +0 -0
- data/docs/{old/collection_manager.md → collection_manager.md} +0 -0
- data/docs/{old/container_philosophy.md → container_philosophy.md} +0 -0
- data/docs/{old/event_binding_helpers.md → event_binding_helpers.md} +0 -0
- data/docs/{old/method_caching_and_computed_properties.md → method_caching_and_computed_properties.md} +0 -0
- data/docs/{old/view.md → view.md} +0 -0
- data/lib/luca/code_browser.rb +55 -0
- data/lib/luca/command_line.rb +69 -0
- data/lib/luca/rails/engine.rb +0 -12
- data/lib/luca/rails/version.rb +2 -1
- data/lib/luca/rails.rb +3 -5
- data/lib/luca/template.rb +0 -2
- data/lib/luca.rb +1 -25
- data/luca.gemspec +7 -16
- data/site/assets/bootstrap.min.js +7 -0
- data/site/assets/dependencies.js +94 -0
- data/site/assets/glyphicons-halflings-white.png +0 -0
- data/site/assets/glyphicons-halflings.png +0 -0
- data/site/assets/luca-ui-bootstrap.css +1331 -0
- data/site/assets/luca-ui-bootstrap.js +9 -0
- data/site/assets/luca-ui-development-tools.css +234 -0
- data/site/assets/luca-ui-development-tools.js +18561 -0
- data/site/assets/luca-ui-development-tools.min.js +15 -0
- data/site/assets/luca-ui-full.min.js +8 -0
- data/site/assets/luca-ui.min.js +4 -0
- data/site/assets/sandbox.css +62 -0
- data/site/assets/sandbox.js +469 -0
- data/site/docs/application.html +41 -0
- data/site/docs/caching.html +43 -0
- data/site/docs/collection.html +75 -0
- data/site/docs/collection_manager.html +71 -0
- data/site/docs/containers.html +118 -0
- data/site/docs/events.html +153 -0
- data/site/docs/view.html +128 -0
- data/site/img/glyphicons-halflings-white.png +0 -0
- data/site/img/glyphicons-halflings.png +0 -0
- data/site/index.html +20 -0
- data/site/source-map.js +1 -0
- data/spec/{javascripts/components → components}/application_spec.coffee +0 -0
- data/spec/{javascripts/components → components}/collection_loader_view_spec.coffee +0 -0
- data/{site/source/app/assets/javascripts/docs/lib/util.coffee → spec/components/controller_spec.coffee} +0 -0
- data/spec/{javascripts/components → components}/fields/checkbox_array_spec.coffee +0 -0
- data/spec/components/form_view_spec.coffee +80 -0
- data/spec/{javascripts/components → components}/grid_view_spec.coffee +0 -0
- data/spec/{javascripts/components → components}/record_manager_spec.coffee +0 -0
- data/spec/{javascripts/components → components}/template_spec.coffee +0 -0
- data/spec/containers/card_view_spec.coffee +50 -0
- data/{site/source/app/assets/javascripts/docs/views/components/code_editor/index.coffee → spec/containers/column_view_spec.coffee} +0 -0
- data/spec/{javascripts/containers → containers}/modal_view_spec.coffee +0 -0
- data/spec/{javascripts/containers → containers}/panel_view_spec.coffee +0 -0
- data/spec/{javascripts/components/pagination_control_spec.coffee → containers/split_view_spec.coffee} +0 -0
- data/spec/{javascripts/containers → containers}/tab_view_spec.coffee +0 -0
- data/spec/{javascripts/containers → containers}/viewport_spec.coffee +0 -0
- data/spec/{javascripts/core → core}/collection_spec.coffee +1 -26
- data/spec/core/container_spec.coffee +66 -0
- data/spec/{javascripts/concerns/paginatable_spec.coffee → core/field_spec.coffee} +0 -0
- data/spec/{javascripts/core → core}/model_spec.coffee +3 -26
- data/spec/{javascripts/core → core}/observer_spec.coffee +0 -0
- data/spec/{javascripts/core → core}/view_spec.coffee +38 -114
- data/spec/{javascripts/core/framework_spec.coffee → framework_spec.coffee} +2 -31
- data/spec/{javascripts/helper.coffee → helper.coffee} +0 -0
- data/spec/{javascripts/managers → managers}/collection_manager_spec.coffee +0 -0
- data/spec/{javascripts/managers → managers}/socket_manager_spec.coffee +0 -0
- data/src/components/application.coffee +318 -0
- data/src/components/base_toolbar.coffee +15 -0
- data/{app/assets/javascripts/luca → src}/components/collection_loader_view.coffee +1 -3
- data/src/components/collection_view.coffee +131 -0
- data/src/components/controller.coffee +63 -0
- data/src/components/fields/button_field.coffee +38 -0
- data/{app/assets/javascripts/luca → src}/components/fields/checkbox_array.coffee +7 -18
- data/{app/assets/javascripts/luca → src}/components/fields/checkbox_field.coffee +10 -19
- data/{app/assets/javascripts/luca → src}/components/fields/file_upload_field.coffee +4 -5
- data/src/components/fields/hidden_field.coffee +12 -0
- data/src/components/fields/label_field.coffee +14 -0
- data/src/components/fields/select_field.coffee +97 -0
- data/src/components/fields/text_area_field.coffee +40 -0
- data/{app/assets/javascripts/luca → src}/components/fields/text_field.coffee +5 -16
- data/src/components/fields/type_ahead_field.coffee +22 -0
- data/src/components/form_button_toolbar.coffee +25 -0
- data/src/components/form_view.coffee +275 -0
- data/src/components/grid_view.coffee +269 -0
- data/src/components/index.coffee +1 -0
- data/src/components/load_mask.coffee +3 -0
- data/src/components/nav_bar.coffee +22 -0
- data/src/components/page_controller.coffee +2 -0
- data/{app/assets/javascripts/luca → src}/components/record_manager.coffee +0 -0
- data/{app/assets/javascripts/luca → src}/components/router.coffee +1 -6
- data/src/components/table_view.coffee +53 -0
- data/src/components/template.coffee +5 -0
- data/src/components/toolbar_dialog.coffee +25 -0
- data/src/containers/card_view.coffee +93 -0
- data/src/containers/column_view.coffee +42 -0
- data/{app/assets/javascripts/luca → src}/containers/modal_view.coffee +9 -9
- data/src/containers/page_view.coffee +2 -0
- data/{app/assets/javascripts/luca → src}/containers/panel_toolbar.coffee +84 -89
- data/src/containers/panel_view.coffee +23 -0
- data/src/containers/split_view.coffee +8 -0
- data/{app/assets/javascripts/luca → src}/containers/tab_view.coffee +21 -27
- data/{app/assets/javascripts/luca → src}/containers/viewport.coffee +18 -14
- data/{app/assets/javascripts/luca → src}/core/collection.coffee +51 -97
- data/src/core/container.coffee +374 -0
- data/{tutorials/component-definitions.md → src/core/core.coffee} +0 -0
- data/src/core/field.coffee +79 -0
- data/src/core/model.coffee +43 -0
- data/{app/assets/javascripts/luca → src}/core/observer.coffee +0 -0
- data/src/core/panel.coffee +118 -0
- data/{app/assets/javascripts/luca/core/registry → src/core}/registry.coffee +43 -63
- data/{app/assets/javascripts/luca/util → src/core}/script_loader.coffee +0 -0
- data/src/core/view.coffee +264 -0
- data/src/define.coffee +110 -0
- data/{app/assets/javascripts/luca → src}/framework.coffee +103 -98
- data/src/index.coffee +23 -0
- data/{app/assets/javascripts/luca → src}/managers/collection_manager.coffee +13 -37
- data/src/managers/socket_manager.coffee +54 -0
- data/{app/assets/javascripts/luca/concerns → src/modules}/deferrable.coffee +4 -5
- data/src/modules/grid_layout.coffee +3 -0
- data/{app/assets/javascripts/luca/concerns/loadmaskable.coffee → src/modules/load_mask.coffee} +11 -23
- data/{app/assets/javascripts/luca/concerns → src/modules}/local_storage.coffee +0 -0
- data/src/plugins/development_tool_helpers.coffee +21 -0
- data/src/plugins/events.coffee +54 -0
- data/src/samples/definition.coffee +49 -0
- data/{tutorials/component-definitions/01_intro.md → src/stylesheets/base.scss} +0 -0
- data/{app/assets/stylesheets/luca → src/stylesheets}/components/checkbox_array.scss +1 -1
- data/src/stylesheets/components/form_view.scss +59 -0
- data/{app/assets/stylesheets/luca → src/stylesheets}/components/grid_view.scss +0 -0
- data/{app/assets/stylesheets/luca → src/stylesheets}/components/load_mask.scss +0 -0
- data/src/stylesheets/components/toolbar.scss +0 -0
- data/{app/assets/stylesheets/luca → src/stylesheets}/components/viewport.scss +4 -1
- data/src/stylesheets/containers/container.scss +16 -0
- data/src/stylesheets/containers/modal_view.scss +0 -0
- data/{app/assets/stylesheets/luca → src/stylesheets}/containers/panels.scss +0 -0
- data/{app/assets/stylesheets/luca → src/stylesheets}/containers/tab_view.scss +5 -5
- data/{app/assets/stylesheets/luca → src/stylesheets}/normalize.scss +0 -0
- data/src/stylesheets/tools/class_browser.scss +32 -0
- data/src/stylesheets/tools/code_editor.scss +24 -0
- data/src/stylesheets/tools/component_tester.scss +26 -0
- data/{app/assets/stylesheets/luca/development → src/stylesheets/tools}/console.scss +0 -0
- data/src/templates/components/bootstrap_form_controls.luca +7 -0
- data/src/templates/components/collection_loader_view.luca +5 -0
- data/src/templates/components/form_alert +0 -0
- data/src/templates/components/form_alert.luca +3 -0
- data/src/templates/components/grid_view.luca +7 -0
- data/src/templates/components/grid_view_empty_text.luca +3 -0
- data/src/templates/components/load_mask.luca +3 -0
- data/src/templates/components/nav_bar.luca +2 -0
- data/src/templates/containers/basic.luca +1 -0
- data/src/templates/containers/tab_selector_container.luca +8 -0
- data/src/templates/containers/tab_view.luca +2 -0
- data/src/templates/containers/toolbar_wrapper.luca +1 -0
- data/src/templates/fields/button_field.luca +2 -0
- data/src/templates/fields/button_field_link.luca +5 -0
- data/src/templates/fields/checkbox_array.luca +4 -0
- data/src/templates/fields/checkbox_array_item.luca +4 -0
- data/src/templates/fields/checkbox_field.luca +9 -0
- data/src/templates/fields/file_upload_field.luca +8 -0
- data/src/templates/fields/hidden_field.luca +1 -0
- data/src/templates/fields/select_field.luca +8 -0
- data/src/templates/fields/text_area_field.luca +8 -0
- data/src/templates/fields/text_field.luca +17 -0
- data/src/templates/sample/contents.luca +1 -0
- data/src/templates/sample/welcome.luca +1 -0
- data/src/templates/table_view.luca +4 -0
- data/src/tools/application_inspector.coffee +2 -0
- data/src/tools/code_editor.coffee +258 -0
- data/{app/assets/javascripts/luca/development → src/tools}/code_mirror_field.coffee +1 -2
- data/src/tools/coffee_script_editor.coffee +82 -0
- data/src/tools/collection_inspector.coffee +4 -0
- data/src/tools/collections/components.coffee +59 -0
- data/src/tools/collections/instances.coffee +15 -0
- data/src/tools/component_tester.coffee +462 -0
- data/{app/assets/javascripts/luca/development → src/tools}/console.coffee +24 -55
- data/src/tools/models/components.coffee +25 -0
- data/src/tools/models/instance.coffee +2 -0
- data/src/tools/templates/component_tester/help.luca +14 -0
- data/{app/assets/javascripts/luca/util/luca.coffee → src/util.coffee} +6 -90
- data/vendor/assets/javascripts/luca-ui-development-tools.js +18533 -0
- data/vendor/assets/javascripts/luca-ui-development-tools.min.js +15 -0
- data/vendor/assets/javascripts/luca-ui-full.js +4806 -0
- data/vendor/assets/javascripts/luca-ui-full.min.js +8 -0
- data/vendor/assets/javascripts/luca-ui-templates.js +24 -0
- data/vendor/assets/javascripts/luca-ui.js +1703 -4394
- data/vendor/assets/javascripts/luca-ui.min.js +4 -5
- data/vendor/assets/luca-ui/base.css +85 -0
- data/vendor/assets/luca-ui/components/application.js +91 -0
- data/vendor/assets/luca-ui/components/base_toolbar.js +23 -0
- data/vendor/assets/luca-ui/components/controller.js +38 -0
- data/vendor/assets/luca-ui/components/fields/button_field.js +45 -0
- data/vendor/assets/luca-ui/components/fields/checkbox_field.js +43 -0
- data/vendor/assets/luca-ui/components/fields/file_upload_field.js +20 -0
- data/vendor/assets/luca-ui/components/fields/hidden_field.js +20 -0
- data/vendor/assets/luca-ui/components/fields/select_field.js +97 -0
- data/vendor/assets/luca-ui/components/fields/text_area_field.js +48 -0
- data/vendor/assets/luca-ui/components/fields/text_field.js +46 -0
- data/vendor/assets/luca-ui/components/fields/type_ahead_field.js +13 -0
- data/vendor/assets/luca-ui/components/form_button_toolbar.js +32 -0
- data/vendor/assets/luca-ui/components/form_view.css +32 -0
- data/vendor/assets/luca-ui/components/form_view.js +207 -0
- data/{app/assets/stylesheets/luca/components/table_view.scss → vendor/assets/luca-ui/components/grid_view.css} +51 -60
- data/vendor/assets/luca-ui/components/grid_view.js +202 -0
- data/vendor/assets/luca-ui/components/record_manager.js +207 -0
- data/vendor/assets/luca-ui/components/router.js +36 -0
- data/vendor/assets/luca-ui/components/template.js +26 -0
- data/vendor/assets/luca-ui/components/toolbar.css +11 -0
- data/vendor/assets/luca-ui/containers/card_view.js +98 -0
- data/vendor/assets/luca-ui/containers/column_view.js +52 -0
- data/vendor/assets/luca-ui/containers/container.css +3 -0
- data/vendor/assets/luca-ui/containers/modal_view.css +0 -0
- data/vendor/assets/luca-ui/containers/modal_view.js +87 -0
- data/vendor/assets/luca-ui/containers/panel_view.js +34 -0
- data/vendor/assets/luca-ui/containers/split_view.js +13 -0
- data/vendor/assets/luca-ui/containers/tab_view.css +16 -0
- data/vendor/assets/luca-ui/containers/tab_view.js +80 -0
- data/vendor/assets/luca-ui/containers/viewport.js +18 -0
- data/vendor/assets/luca-ui/core/collection.js +221 -0
- data/vendor/assets/luca-ui/core/container.js +205 -0
- data/vendor/assets/luca-ui/core/field.js +59 -0
- data/vendor/assets/luca-ui/core/observer.js +42 -0
- data/vendor/assets/luca-ui/core/view.js +127 -0
- data/vendor/assets/luca-ui/framework.js +110 -0
- data/vendor/assets/luca-ui/index.js +5 -0
- data/vendor/assets/luca-ui/managers/collection_manager.js +98 -0
- data/vendor/assets/luca-ui/managers/socket_manager.js +52 -0
- data/vendor/assets/luca-ui/modules/deferrable.js +21 -0
- data/vendor/assets/luca-ui/modules/local_storage.js +81 -0
- data/vendor/assets/luca-ui/normalize.css +359 -0
- data/vendor/assets/luca-ui/stylesheets/base.css +85 -0
- data/vendor/assets/luca-ui/stylesheets/components/form_view.css +32 -0
- data/vendor/assets/luca-ui/stylesheets/components/grid_view.css +76 -0
- data/vendor/assets/luca-ui/stylesheets/components/toolbar.css +11 -0
- data/vendor/assets/luca-ui/stylesheets/containers/container.css +3 -0
- data/vendor/assets/luca-ui/stylesheets/containers/modal_view.css +0 -0
- data/vendor/assets/luca-ui/stylesheets/containers/tab_view.css +16 -0
- data/vendor/assets/luca-ui/stylesheets/normalize.css +359 -0
- data/vendor/assets/luca-ui/templates/components/bootstrap_form_controls.js +4 -0
- data/vendor/assets/luca-ui/templates/components/form_view.js +4 -0
- data/vendor/assets/luca-ui/templates/components/grid_view.js +4 -0
- data/vendor/assets/luca-ui/templates/components/grid_view_empty_text.js +4 -0
- data/vendor/assets/luca-ui/templates/containers/basic.js +4 -0
- data/vendor/assets/luca-ui/templates/containers/tab_selector_container.js +4 -0
- data/vendor/assets/luca-ui/templates/containers/tab_view.js +4 -0
- data/vendor/assets/luca-ui/templates/containers/toolbar_wrapper.js +4 -0
- data/vendor/assets/luca-ui/templates/fields/button_field.js +4 -0
- data/vendor/assets/luca-ui/templates/fields/button_field_link.js +4 -0
- data/vendor/assets/luca-ui/templates/fields/checkbox_field.js +4 -0
- data/vendor/assets/luca-ui/templates/fields/file_upload_field.js +4 -0
- data/vendor/assets/luca-ui/templates/fields/hidden_field.js +4 -0
- data/vendor/assets/luca-ui/templates/fields/select_field.js +4 -0
- data/vendor/assets/luca-ui/templates/fields/text_area_field.js +4 -0
- data/vendor/assets/luca-ui/templates/fields/text_field.js +4 -0
- data/vendor/assets/luca-ui/templates/sample/contents.js +4 -0
- data/vendor/assets/luca-ui/templates/sample/welcome.js +4 -0
- data/vendor/assets/stylesheets/luca-ui.css +471 -68
- data/views/jasmine.erb +2 -2
- metadata +328 -496
- data/app/assets/javascripts/luca/basic.coffee +0 -8
- data/app/assets/javascripts/luca/components/application.coffee +0 -530
- data/app/assets/javascripts/luca/components/collection_view.coffee +0 -211
- data/app/assets/javascripts/luca/components/controller.coffee +0 -176
- data/app/assets/javascripts/luca/components/fields/base.coffee +0 -144
- data/app/assets/javascripts/luca/components/fields/button_field.coffee +0 -91
- data/app/assets/javascripts/luca/components/fields/hidden_field.coffee +0 -11
- data/app/assets/javascripts/luca/components/fields/label_field.coffee +0 -12
- data/app/assets/javascripts/luca/components/fields/select_field.coffee +0 -159
- data/app/assets/javascripts/luca/components/fields/text_area_field.coffee +0 -57
- data/app/assets/javascripts/luca/components/fields/type_ahead_field.coffee +0 -20
- data/app/assets/javascripts/luca/components/form_view.coffee +0 -421
- data/app/assets/javascripts/luca/components/grid_layout_view.coffee +0 -42
- data/app/assets/javascripts/luca/components/index.coffee +0 -7
- data/app/assets/javascripts/luca/components/load_mask.coffee +0 -8
- data/app/assets/javascripts/luca/components/multi_collection_view.coffee +0 -92
- data/app/assets/javascripts/luca/components/nav_bar.coffee +0 -80
- data/app/assets/javascripts/luca/components/page.coffee +0 -70
- data/app/assets/javascripts/luca/components/pagination_control.coffee +0 -104
- data/app/assets/javascripts/luca/components/simple_collection_view.coffee +0 -10
- data/app/assets/javascripts/luca/components/table_view.coffee +0 -93
- data/app/assets/javascripts/luca/components/table_view_scrollable.coffee +0 -23
- data/app/assets/javascripts/luca/concerns/application_event_bindings.coffee +0 -19
- data/app/assets/javascripts/luca/concerns/collection_event_bindings.coffee +0 -47
- data/app/assets/javascripts/luca/concerns/development_tool_helpers.coffee +0 -30
- data/app/assets/javascripts/luca/concerns/dom_helpers.coffee +0 -61
- data/app/assets/javascripts/luca/concerns/enhanced_properties.coffee +0 -23
- data/app/assets/javascripts/luca/concerns/filterable.coffee +0 -101
- data/app/assets/javascripts/luca/concerns/form_model_bindings.coffee +0 -20
- data/app/assets/javascripts/luca/concerns/grid_layout.coffee +0 -15
- data/app/assets/javascripts/luca/concerns/modal_view.coffee +0 -63
- data/app/assets/javascripts/luca/concerns/model_presenter.coffee +0 -23
- data/app/assets/javascripts/luca/concerns/paginatable.coffee +0 -79
- data/app/assets/javascripts/luca/concerns/query_collection_bindings.coffee +0 -52
- data/app/assets/javascripts/luca/concerns/sortable.coffee +0 -69
- data/app/assets/javascripts/luca/concerns/state_model.coffee +0 -58
- data/app/assets/javascripts/luca/concerns/templating.coffee +0 -13
- data/app/assets/javascripts/luca/config.coffee +0 -54
- data/app/assets/javascripts/luca/containers/card_view.coffee +0 -178
- data/app/assets/javascripts/luca/containers/container.coffee +0 -711
- data/app/assets/javascripts/luca/containers/index.coffee +0 -2
- data/app/assets/javascripts/luca/containers/page_controller.coffee +0 -25
- data/app/assets/javascripts/luca/core/events.coffee +0 -114
- data/app/assets/javascripts/luca/core/index.coffee +0 -12
- data/app/assets/javascripts/luca/core/model.coffee +0 -56
- data/app/assets/javascripts/luca/core/panel.coffee +0 -124
- data/app/assets/javascripts/luca/core/registry/component_definition.coffee +0 -319
- data/app/assets/javascripts/luca/core/registry/concerns.coffee +0 -70
- data/app/assets/javascripts/luca/core/registry/index.coffee +0 -4
- data/app/assets/javascripts/luca/core/registry/meta_data.coffee +0 -99
- data/app/assets/javascripts/luca/core/templates.coffee +0 -51
- data/app/assets/javascripts/luca/core/view.coffee +0 -383
- data/app/assets/javascripts/luca/dependencies.coffee +0 -9
- data/app/assets/javascripts/luca/development/code_sync_manager.coffee +0 -173
- data/app/assets/javascripts/luca/development/component.coffee +0 -76
- data/app/assets/javascripts/luca/development/components.coffee +0 -57
- data/app/assets/javascripts/luca/development/index.coffee +0 -5
- data/app/assets/javascripts/luca/index.coffee +0 -9
- data/app/assets/javascripts/luca/managers/index.coffee +0 -2
- data/app/assets/javascripts/luca/managers/socket_manager.coffee +0 -89
- data/app/assets/javascripts/luca/templates/components/bootstrap_form_controls.jst.ejs +0 -10
- data/app/assets/javascripts/luca/templates/components/collection_loader_view.jst.ejs +0 -6
- data/app/assets/javascripts/luca/templates/components/form_alert.jst.ejs +0 -4
- data/app/assets/javascripts/luca/templates/components/grid_view.jst.ejs +0 -11
- data/app/assets/javascripts/luca/templates/components/grid_view_empty_text.jst.ejs +0 -3
- data/app/assets/javascripts/luca/templates/components/load_mask.jst.ejs +0 -5
- data/app/assets/javascripts/luca/templates/components/nav_bar.jst.ejs +0 -19
- data/app/assets/javascripts/luca/templates/components/pagination.jst.ejs +0 -10
- data/app/assets/javascripts/luca/templates/components/table_view.jst.ejs +0 -4
- data/app/assets/javascripts/luca/templates/containers/basic.jst.ejs +0 -1
- data/app/assets/javascripts/luca/templates/containers/tab_selector_container.jst.ejs +0 -12
- data/app/assets/javascripts/luca/templates/containers/tab_view.jst.ejs +0 -2
- data/app/assets/javascripts/luca/templates/containers/toolbar_wrapper.jst.ejs +0 -1
- data/app/assets/javascripts/luca/templates/fields/button_field.jst.ejs +0 -2
- data/app/assets/javascripts/luca/templates/fields/button_field_link.jst.ejs +0 -6
- data/app/assets/javascripts/luca/templates/fields/checkbox_array.jst.ejs +0 -4
- data/app/assets/javascripts/luca/templates/fields/checkbox_array_item.jst.ejs +0 -3
- data/app/assets/javascripts/luca/templates/fields/checkbox_field.jst.ejs +0 -10
- data/app/assets/javascripts/luca/templates/fields/file_upload_field.jst.ejs +0 -10
- data/app/assets/javascripts/luca/templates/fields/hidden_field.jst.ejs +0 -1
- data/app/assets/javascripts/luca/templates/fields/select_field.jst.ejs +0 -11
- data/app/assets/javascripts/luca/templates/fields/text_area_field.jst.ejs +0 -11
- data/app/assets/javascripts/luca/templates/fields/text_field.jst.ejs +0 -16
- data/app/assets/javascripts/luca/util/deprecations.coffee +0 -18
- data/app/assets/javascripts/luca/util/index.coffee +0 -4
- data/app/assets/javascripts/luca/util/keybindings.coffee +0 -24
- data/app/assets/javascripts/luca/util/logging.coffee +0 -30
- data/app/assets/javascripts/luca-ui.js +0 -1
- data/app/assets/stylesheets/luca/components/form_view.scss +0 -7
- data/app/assets/stylesheets/luca/containers/container.scss +0 -19
- data/app/assets/stylesheets/luca/development/index.css +0 -3
- data/app/assets/stylesheets/luca/index.css +0 -4
- data/bin/luca +0 -14
- data/docs/framework.json +0 -1
- data/docs/luca-framework-documentation.js +0 -1
- data/lib/generators/luca/application/application_generator.rb +0 -75
- data/lib/generators/luca/application/templates/controller.rb +0 -4
- data/lib/generators/luca/application/templates/index.html.erb +0 -19
- data/lib/generators/luca/application/templates/index.html.haml +0 -7
- data/lib/generators/luca/application/templates/javascripts/application.coffee +0 -18
- data/lib/generators/luca/application/templates/javascripts/collection_manager.coffee +0 -2
- data/lib/generators/luca/application/templates/javascripts/config.coffee +0 -3
- data/lib/generators/luca/application/templates/javascripts/dependencies.coffee +0 -3
- data/lib/generators/luca/application/templates/javascripts/home.jst.ejs +0 -2
- data/lib/generators/luca/application/templates/javascripts/index.coffee +0 -15
- data/lib/generators/luca/application/templates/javascripts/router.coffee +0 -4
- data/lib/guard/luca.rb +0 -84
- data/lib/luca/asset_compiler.rb +0 -117
- data/lib/luca/cli/generate.rb +0 -37
- data/lib/luca/cli/server.rb +0 -20
- data/lib/luca/cli/sync.rb +0 -40
- data/lib/luca/cli/watch.rb +0 -16
- data/lib/luca/cli.rb +0 -68
- data/lib/luca/collection/endpoint.rb +0 -38
- data/lib/luca/collection/file_backend.rb +0 -121
- data/lib/luca/collection/redis_backend.rb +0 -153
- data/lib/luca/collection.rb +0 -64
- data/lib/luca/compiled_asset.rb +0 -61
- data/lib/luca/component_definition.rb +0 -356
- data/lib/luca/luca_application.rb +0 -258
- data/lib/luca/project.rb +0 -73
- data/lib/luca/project_harness.rb +0 -96
- data/lib/luca/server.rb +0 -7
- data/lib/luca/stylesheet.rb +0 -35
- data/lib/luca/template_asset.rb +0 -64
- data/lib/luca/version.rb +0 -3
- data/lib/luca/watcher.rb +0 -72
- data/lib/railties/luca/tasks.rake +0 -38
- data/site/.bundle/config +0 -2
- data/site/.gitignore +0 -5
- data/site/.rvmrc +0 -1
- data/site/CHANGELOG.md +0 -41
- data/site/DOCS.md +0 -41
- data/site/Gemfile +0 -8
- data/site/Gemfile.lock +0 -134
- data/site/LICENSE.md +0 -19
- data/site/config.rb +0 -84
- data/site/helpers/site_helpers.rb +0 -20
- data/site/html5bp-docs/README.md +0 -38
- data/site/html5bp-docs/contribute.md +0 -104
- data/site/html5bp-docs/crossdomain.md +0 -21
- data/site/html5bp-docs/css.md +0 -135
- data/site/html5bp-docs/extend.md +0 -507
- data/site/html5bp-docs/faq.md +0 -77
- data/site/html5bp-docs/htaccess.md +0 -323
- data/site/html5bp-docs/html.md +0 -170
- data/site/html5bp-docs/js.md +0 -31
- data/site/html5bp-docs/misc.md +0 -25
- data/site/html5bp-docs/usage.md +0 -109
- data/site/readme.md +0 -47
- data/site/source/.htaccess +0 -540
- data/site/source/404.html +0 -157
- data/site/source/app/assets/javascripts/dependencies.js.coffee +0 -6
- data/site/source/app/assets/javascripts/docs/application.coffee +0 -64
- data/site/source/app/assets/javascripts/docs/collections/docs_documentation.coffee +0 -17
- data/site/source/app/assets/javascripts/docs/collections/github_repositories.coffee +0 -7
- data/site/source/app/assets/javascripts/docs/collections/index.coffee +0 -1
- data/site/source/app/assets/javascripts/docs/collections/luca_documentation.coffee +0 -17
- data/site/source/app/assets/javascripts/docs/collections/public_gists.coffee +0 -4
- data/site/source/app/assets/javascripts/docs/config.coffee +0 -5
- data/site/source/app/assets/javascripts/docs/index.coffee +0 -12
- data/site/source/app/assets/javascripts/docs/lib/router.coffee +0 -3
- data/site/source/app/assets/javascripts/docs/models/component.coffee +0 -99
- data/site/source/app/assets/javascripts/docs/models/github_repository.coffee +0 -3
- data/site/source/app/assets/javascripts/docs/models/index.coffee +0 -1
- data/site/source/app/assets/javascripts/docs/templates/component_documentation.jst.ejs +0 -55
- data/site/source/app/assets/javascripts/docs/templates/examples_browser/overview.jst.ejs +0 -4
- data/site/source/app/assets/javascripts/docs/templates/examples_browser/selector.jst.ejs +0 -11
- data/site/source/app/assets/javascripts/docs/templates/github_repository.jst.ejs +0 -4
- data/site/source/app/assets/javascripts/docs/templates/layouts/main.jst.ejs +0 -4
- data/site/source/app/assets/javascripts/docs/templates/left_navigation.jst.ejs +0 -5
- data/site/source/app/assets/javascripts/docs/templates/pages/getting_started.jst.ejs +0 -78
- data/site/source/app/assets/javascripts/docs/templates/pages/home.jst.ejs +0 -57
- data/site/source/app/assets/javascripts/docs/views/components/code_editor.coffee +0 -45
- data/site/source/app/assets/javascripts/docs/views/components/component_documentation.coffee +0 -72
- data/site/source/app/assets/javascripts/docs/views/index.coffee +0 -3
- data/site/source/app/assets/javascripts/docs/views/pages/browse_source/details.coffee +0 -37
- data/site/source/app/assets/javascripts/docs/views/pages/browse_source/list.coffee +0 -31
- data/site/source/app/assets/javascripts/docs/views/pages/browse_source.coffee +0 -46
- data/site/source/app/assets/javascripts/docs/views/pages/component_editor.coffee +0 -10
- data/site/source/app/assets/javascripts/docs/views/pages/examples_browser/docs.coffee +0 -12
- data/site/source/app/assets/javascripts/docs/views/pages/examples_browser/source.coffee +0 -13
- data/site/source/app/assets/javascripts/docs/views/pages/examples_browser.coffee +0 -102
- data/site/source/app/assets/javascripts/docs/views/pages/home.coffee +0 -10
- data/site/source/app/assets/javascripts/docs/views/views/api_browser/index.coffee +0 -43
- data/site/source/app/assets/javascripts/docs/views/views/collection_view_examples/grid_layout_view_example.coffee +0 -14
- data/site/source/app/assets/javascripts/docs/views/views/collection_view_examples/table_view_example.coffee +0 -39
- data/site/source/app/assets/javascripts/docs/views/views/form_view_examples/basic_example.coffee +0 -38
- data/site/source/app/assets/javascripts/docs/views/views/form_view_examples/complex_layout.coffee +0 -110
- data/site/source/app/assets/javascripts/docs/views/views/top_navigation.coffee +0 -6
- data/site/source/app/assets/javascripts/docs-docs.js +0 -1
- data/site/source/app/assets/javascripts/luca-docs.js +0 -1
- data/site/source/app/assets/javascripts/luca-framework-documentation.js +0 -1
- data/site/source/app/assets/javascripts/site.js.coffee +0 -4
- data/site/source/app/assets/javascripts/vendor/codemirror.js +0 -4786
- data/site/source/app/assets/javascripts/vendor/coffeescript.js +0 -346
- data/site/source/app/assets/javascripts/vendor/css.js +0 -465
- data/site/source/app/assets/javascripts/vendor/htmlmixed.js +0 -84
- data/site/source/app/assets/javascripts/vendor/javascript.js +0 -422
- data/site/source/app/assets/javascripts/vendor/js-beautify.js +0 -1353
- data/site/source/app/assets/javascripts/vendor/modernizr-2.6.1.min.js +0 -4
- data/site/source/app/assets/javascripts/vendor/vim.js +0 -2511
- data/site/source/app/assets/stylesheets/docs/api-browser.css.scss +0 -5
- data/site/source/app/assets/stylesheets/docs/application.css.scss +0 -35
- data/site/source/app/assets/stylesheets/docs/browse-source.css.scss +0 -5
- data/site/source/app/assets/stylesheets/docs/scrollable-table.css.scss +0 -5
- data/site/source/app/assets/stylesheets/site.css.scss +0 -2
- data/site/source/app/assets/stylesheets/vendor/codemirror.css +0 -240
- data/site/source/app/assets/stylesheets/vendor/prettify-tomorrow-night-bright.css +0 -160
- data/site/source/app/assets/stylesheets/vendor/twilight.css +0 -26
- data/site/source/crossdomain.xml +0 -15
- data/site/source/documentation.html.haml +0 -1
- data/site/source/favicon_base.png +0 -0
- data/site/source/humans.txt +0 -15
- data/site/source/images/background.png +0 -0
- data/site/source/images/middleman.png +0 -0
- data/site/source/index.html.haml +0 -1
- data/site/source/layouts/layout.haml +0 -55
- data/site/source/readme.md +0 -63
- data/site/source/robots.txt +0 -3
- data/spec/javascripts/components/collection_view_spec.coffee +0 -59
- data/spec/javascripts/components/controller_spec.coffee +0 -62
- data/spec/javascripts/components/form_view_spec.coffee +0 -162
- data/spec/javascripts/components/multi_collection_view_spec.coffee +0 -5
- data/spec/javascripts/components/table_view_spec.coffee +0 -17
- data/spec/javascripts/concerns/collection_event_bindings_spec.coffee +0 -15
- data/spec/javascripts/concerns/dom_helpers_spec.coffee +0 -16
- data/spec/javascripts/concerns/filterable_spec.coffee +0 -25
- data/spec/javascripts/concerns/model_presenter_spec.coffee +0 -31
- data/spec/javascripts/concerns/state_model_spec.coffee +0 -55
- data/spec/javascripts/containers/card_view_spec.coffee +0 -108
- data/spec/javascripts/core/concerns_spec.coffee +0 -88
- data/spec/javascripts/core/container_spec.coffee +0 -287
- data/spec/javascripts/core/define_spec.coffee +0 -116
- data/spec/javascripts/core/events_spec.coffee +0 -26
- data/spec/javascripts/core/field_spec.coffee +0 -4
- data/spec/javascripts/core/util_spec.coffee +0 -24
- data/spec/javascripts/dependencies/index.coffee +0 -3
- data/spec/lib/component_definition_spec.rb +0 -63
- data/spec/lib/input_compiler_spec.rb +0 -9
- data/spec/lib/luca_application_spec.rb +0 -30
- data/spec/support/fixtures/application.coffee +0 -45
- data/spec/support/fixtures/component.coffee +0 -34
- data/tutorials/component-driven-design.md +0 -140
- data/tutorials/structure-of-a-project.md +0 -63
- data/vendor/assets/javascripts/backbone-ext.js +0 -21
- data/vendor/assets/javascripts/backbone-min.js +0 -42
- data/vendor/assets/javascripts/backbone-query.min.js +0 -1
- data/vendor/assets/javascripts/bootstrap.min.js +0 -7
- data/vendor/assets/javascripts/codemirror-ui.js +0 -503
- data/vendor/assets/javascripts/hogan.js +0 -707
- data/vendor/assets/javascripts/inflections.js +0 -656
- data/vendor/assets/javascripts/jasmine-html.js +0 -190
- data/vendor/assets/javascripts/jasmine.js +0 -2476
- data/vendor/assets/javascripts/jquery.js +0 -5
- data/vendor/assets/javascripts/keymaster.min.js +0 -4
- data/vendor/assets/javascripts/luca-dependencies.min.js +0 -8
- data/vendor/assets/javascripts/luca-development.min.js +0 -1
- data/vendor/assets/javascripts/luca-spec.js +0 -11
- data/vendor/assets/javascripts/luca.full.min.js +0 -12
- data/vendor/assets/javascripts/luca.min.js +0 -5
- data/vendor/assets/javascripts/sinon.js +0 -3469
- data/vendor/assets/javascripts/underscore-min.js +0 -1
- data/vendor/assets/javascripts/underscore-string.min.js +0 -1
- data/vendor/assets/stylesheets/bootstrap-responsive.min.css +0 -9
- data/vendor/assets/stylesheets/bootstrap.min.css +0 -9
- data/vendor/assets/stylesheets/luca-components.css +0 -202
- data/vendor/assets/stylesheets/luca-development.css +0 -23
@@ -1,323 +0,0 @@
|
|
1
|
-
[HTML5 Boilerplate homepage](http://html5boilerplate.com) | [Documentation
|
2
|
-
table of contents](README.md)
|
3
|
-
|
4
|
-
# .htaccess
|
5
|
-
|
6
|
-
In Apache HTTP server, `.htaccess` (hypertext access) is the configuration file
|
7
|
-
that allows for web server configuration. HTML5 Boilerplate includes a number
|
8
|
-
of best practice server rules for making web pages fast and secure, these rules
|
9
|
-
can be applied by configuring `.htaccess` file.
|
10
|
-
|
11
|
-
**You'll want to have these modules enabled for optimum performance:**
|
12
|
-
|
13
|
-
* `mod_setenvif.c` (setenvif_module)
|
14
|
-
* `mod_headers.c` (headers_module)
|
15
|
-
* `mod_deflate.c` (deflate_module)
|
16
|
-
* `mod_filter.c` (filter_module)
|
17
|
-
* `mod_expires.c` (expires_module)
|
18
|
-
* `mod_rewrite.c` (rewrite_module)
|
19
|
-
|
20
|
-
|
21
|
-
## On Windows
|
22
|
-
|
23
|
-
You've got a couple of options that depend on how you installed Apache.
|
24
|
-
|
25
|
-
1. **WampServer**. This is by far the simplest option. If you have installed
|
26
|
-
WampServer just click on the icon in the task bar, hover over the Apache
|
27
|
-
section in the menu that comes up and then hover over the modules section.
|
28
|
-
You will be presented with a list of modules. Simply click on a module name
|
29
|
-
to enable it (or disable it if it is already enabled). A check mark next to
|
30
|
-
a module indicates that it is enabled. WampServer will automatically restart
|
31
|
-
the Apache service after you enable a module.
|
32
|
-
|
33
|
-
2. **Manually editing `httpd.conf`**. This assumes that you have manually
|
34
|
-
installed Apache. You will need to locate the `httpd.conf` file which is
|
35
|
-
normally in the `conf` folder in the folder where you installed Apache (for
|
36
|
-
example `C:\apache\conf\httpd.conf`). Open up this file in a text editor. Near
|
37
|
-
the top (after a bunch of comments) you will see a long list of modules. Check
|
38
|
-
to make sure that the modules listed above are not commented out. If they
|
39
|
-
are, go ahead and uncomment them and restart Apache.
|
40
|
-
|
41
|
-
That's it, you're done!
|
42
|
-
|
43
|
-
|
44
|
-
## On Linux
|
45
|
-
|
46
|
-
These instructions should work on any distribution where `apt-get` has been
|
47
|
-
used to install Apache.
|
48
|
-
|
49
|
-
1. Open up a terminal and type the following command. Enter your password when
|
50
|
-
prompted.
|
51
|
-
|
52
|
-
`sudo a2enmod setenvif headers deflate filter expires rewrite include`
|
53
|
-
|
54
|
-
1. Restart apache by using the following command so the new configuration takes
|
55
|
-
effect.
|
56
|
-
|
57
|
-
`sudo /etc/init.d/apache2 restart`
|
58
|
-
|
59
|
-
That's it, you're done!
|
60
|
-
|
61
|
-
|
62
|
-
## On Mac
|
63
|
-
|
64
|
-
Coming soon...
|
65
|
-
|
66
|
-
|
67
|
-
## Security
|
68
|
-
|
69
|
-
Do not turn off your ServerSignature (i.e., the `Server:` HTTP header). Serious
|
70
|
-
attackers can use other kinds of fingerprinting methods to figure out the
|
71
|
-
actual server and components running behind a port. Instead, as a site owner,
|
72
|
-
you should keep track of what's listening on ports on hosts that you control.
|
73
|
-
Run a periodic scanner to make sure nothing suspicious is running on a host you
|
74
|
-
control, and use the ServerSignature to determine if this is the web server and
|
75
|
-
version that you expect.
|
76
|
-
|
77
|
-
|
78
|
-
## Performance
|
79
|
-
|
80
|
-
### Configure ETags
|
81
|
-
|
82
|
-
```apache
|
83
|
-
FileETag None
|
84
|
-
```
|
85
|
-
|
86
|
-
Entity tags (ETags) is a mechanism that web servers and browsers use to
|
87
|
-
determine whether the component in the browser's cache matches the one on the
|
88
|
-
origin server. (An "entity" is another word a "component": images, scripts,
|
89
|
-
stylesheets, etc.) ETags were added to provide a mechanism for validating
|
90
|
-
entities that is more flexible than the last-modified date. An `ETag` is a
|
91
|
-
string that uniquely identifies a specific version of a component. The only
|
92
|
-
format constraints are that the string be quoted. The origin server specifies
|
93
|
-
the component's `ETag` using the `ETag` response header.
|
94
|
-
|
95
|
-
```http
|
96
|
-
HTTP/1.1 200 OK
|
97
|
-
Last-Modified: Tue, 12 Dec 2006 03:03:59 GMT
|
98
|
-
ETag: "10c24bc-4ab-457e1c1f"
|
99
|
-
Content-Length: 12195
|
100
|
-
```
|
101
|
-
|
102
|
-
Later, if the browser has to validate a component, it uses the `If-None-Match`
|
103
|
-
header to pass the `ETag` back to the origin server. If the ETags match, a 304
|
104
|
-
status code is returned reducing the response by 12195 bytes for this
|
105
|
-
example.
|
106
|
-
|
107
|
-
```http
|
108
|
-
GET /i/yahoo.gif HTTP/1.1
|
109
|
-
Host: us.yimg.com
|
110
|
-
If-Modified-Since: Tue, 12 Dec 2006 03:03:59 GMT
|
111
|
-
If-None-Match: "10c24bc-4ab-457e1c1f"
|
112
|
-
HTTP/1.1 304 Not Modified
|
113
|
-
```
|
114
|
-
|
115
|
-
The problem with ETags is that they typically are constructed using attributes
|
116
|
-
that make them unique to a specific server hosting a site. ETags won't match
|
117
|
-
when a browser gets the original component from one server and later tries to
|
118
|
-
validate that component on a different server, a situation that is all too
|
119
|
-
common on web sites that use a cluster of servers to handle requests. By
|
120
|
-
default, both Apache and IIS embed data in the ETag that dramatically reduces
|
121
|
-
the odds of the validity test succeeding on web sites with multiple servers.
|
122
|
-
|
123
|
-
The ETag format for Apache 1.3 and 2.x is inode-size-timestamp. Although a
|
124
|
-
given file may reside in the same directory across multiple servers, and have
|
125
|
-
the same file size, permissions, timestamp, etc., its inode is different from
|
126
|
-
one server to the next.
|
127
|
-
|
128
|
-
IIS 5.0 and 6.0 have a similar issue with ETags. The format for ETags on IIS is
|
129
|
-
Filetimestamp:ChangeNumber. A ChangeNumber is a counter used to track
|
130
|
-
configuration changes to IIS. It's unlikely that the ChangeNumber is the same
|
131
|
-
across all IIS servers behind a web site.
|
132
|
-
|
133
|
-
The end result is ETags generated by Apache and IIS for the exact same
|
134
|
-
component won't match from one server to another. If the ETags don't match, the
|
135
|
-
user doesn't receive the small, fast 304 response that ETags were designed for;
|
136
|
-
instead, they'll get a normal 200 response along with all the data for the
|
137
|
-
component. If you host your web site on just one server, this isn't a problem.
|
138
|
-
But if you have multiple servers hosting your web site, and you're using Apache
|
139
|
-
or IIS with the default ETag configuration, your users are getting slower
|
140
|
-
pages, your servers have a higher load, you're consuming greater bandwidth, and
|
141
|
-
proxies aren't caching your content efficiently. Even if your components have a
|
142
|
-
far future Expires header, a conditional GET request is still made whenever the
|
143
|
-
user hits Reload or Refresh.
|
144
|
-
|
145
|
-
If you're not taking advantage of the flexible validation model that ETags
|
146
|
-
provide, it's better to just remove the ETag altogether. The Last-Modified
|
147
|
-
header validates based on the component's timestamp. And removing the ETag
|
148
|
-
reduces the size of the HTTP headers in both the response and subsequent
|
149
|
-
requests. This Microsoft Support article describes how to remove ETags. In
|
150
|
-
Apache, this is done by simply adding the above line to your Apache
|
151
|
-
configuration file.
|
152
|
-
|
153
|
-
|
154
|
-
### Gzip Components
|
155
|
-
|
156
|
-
Compression reduces response times by reducing the size of the HTTP response.
|
157
|
-
|
158
|
-
Starting with HTTP/1.1, web clients indicate support for compression with the
|
159
|
-
Accept-Encoding header in the HTTP request.
|
160
|
-
|
161
|
-
```
|
162
|
-
Accept-Encoding: gzip, deflate
|
163
|
-
```
|
164
|
-
|
165
|
-
If the web server sees this header in the request, it may compress the response
|
166
|
-
using one of the methods listed by the client. The web server notifies the web
|
167
|
-
client of this via the Content-Encoding header in the response.
|
168
|
-
|
169
|
-
```
|
170
|
-
Content-Encoding: gzip
|
171
|
-
```
|
172
|
-
|
173
|
-
Gzip is the most popular and effective compression method at this time. It was
|
174
|
-
developed by the GNU project and standardized by RFC 1952. The only other
|
175
|
-
compression format you're likely to see is deflate, but it's less effective and
|
176
|
-
less popular.
|
177
|
-
|
178
|
-
Gzipping generally reduces the response size by about 70%. Approximately 90% of
|
179
|
-
today's Internet traffic travels through browsers that claim to support gzip.
|
180
|
-
If you use Apache, the module configuring gzip depends on your version: Apache
|
181
|
-
1.3 uses `mod_gzip` while Apache 2.x uses `mod_deflate`.
|
182
|
-
|
183
|
-
There are known issues with browsers and proxies that may cause a mismatch in
|
184
|
-
what the browser expects and what it receives with regard to compressed
|
185
|
-
content. Fortunately, these edge cases are dwindling as the use of older
|
186
|
-
browsers drops off. The Apache modules help out by adding appropriate Vary
|
187
|
-
response headers automatically.
|
188
|
-
|
189
|
-
Servers choose what to gzip based on file type, but are typically too limited
|
190
|
-
in what they decide to compress. Most web sites gzip their HTML documents. It's
|
191
|
-
also worthwhile to gzip your scripts and stylesheets, but many web sites miss
|
192
|
-
this opportunity. In fact, it's worthwhile to compress any text response
|
193
|
-
including XML and JSON. Image and PDF files should not be gzipped because they
|
194
|
-
are already compressed. Trying to gzip them not only wastes CPU but can
|
195
|
-
potentially increase file sizes.
|
196
|
-
|
197
|
-
Gzipping as many appropriate file types as possible is an easy way to reduce
|
198
|
-
page weight and accelerate the user experience.
|
199
|
-
|
200
|
-
|
201
|
-
### Cache busting
|
202
|
-
|
203
|
-
A first-time visitor to your page may have to make several HTTP requests, but
|
204
|
-
by using the Expires header you make those components cacheable. This avoids
|
205
|
-
unnecessary HTTP requests on subsequent page views. Expires headers are most
|
206
|
-
often used with images, but they should be used on all components including
|
207
|
-
scripts, stylesheets, etc.
|
208
|
-
|
209
|
-
Traditionally, if you use a far future Expires header you have to change the
|
210
|
-
component's filename whenever the component changes.
|
211
|
-
|
212
|
-
The H5BP `.htaccess` has built-in filename cache busting. To use it, uncomment
|
213
|
-
the relevant lines in the `.htaccess` file.
|
214
|
-
|
215
|
-
Doing so will route all requests for `/path/filename.20120101.ext` to
|
216
|
-
`/path/filename.ext`. To use this, just add a time-stamp number (or your own
|
217
|
-
numbered versioning system) into your resource filenames in your HTML source
|
218
|
-
whenever you update those resources.
|
219
|
-
|
220
|
-
#### Example:
|
221
|
-
|
222
|
-
```html
|
223
|
-
<script src="/js/myscript.20120305.js"></script>
|
224
|
-
<script src="/js/jqueryplugin.45.js"></script>
|
225
|
-
<link rel="stylesheet" href="css/somestyle.49559939932.css">
|
226
|
-
<link rel="stylesheet" href="css/anotherstyle.2.css">
|
227
|
-
```
|
228
|
-
|
229
|
-
**N.B. You do not have to rename the resource on the filesystem.** All you have
|
230
|
-
to do is add the timestamp number to the filename in your HTML source. The
|
231
|
-
`.htaccess` directive will serve up the proper file.
|
232
|
-
|
233
|
-
Traditional cache busting involved adding a query string to the end of your
|
234
|
-
JavaScript or CSS filename whenever you updated it.
|
235
|
-
|
236
|
-
```html
|
237
|
-
<script src="/js/all.js?v=12"></script>
|
238
|
-
```
|
239
|
-
|
240
|
-
However, as [Steve Souders](http://stevesouders.com/) explains in [*Revving
|
241
|
-
Filenames: don’t use
|
242
|
-
querystring*](http://www.stevesouders.com/blog/2008/08/23/revving-filenames-dont-use-querystring/),
|
243
|
-
the query string approach is not always reliable for clients behind a Squid
|
244
|
-
Proxy Server.
|
245
|
-
|
246
|
-
|
247
|
-
## Trailing slash redirects
|
248
|
-
|
249
|
-
Trailing slash redirects can be done by adding one of the options below in `.htaccess`.
|
250
|
-
|
251
|
-
### Option 1
|
252
|
-
Rewrite `domain.com/foo` -> `domain.com/foo/`.
|
253
|
-
|
254
|
-
```apache
|
255
|
-
RewriteCond %{REQUEST_FILENAME} !-f
|
256
|
-
RewriteCond %{REQUEST_URI} !(\.[a-zA-Z0-9]{1,5}|/|#(.*))$
|
257
|
-
RewriteRule ^(.*)$ $1/ [R=301,L]
|
258
|
-
```
|
259
|
-
|
260
|
-
### Option 2
|
261
|
-
Rewrite `domain.com/foo/` -> `domain.com/foo`
|
262
|
-
|
263
|
-
```apache
|
264
|
-
RewriteRule ^(.*)/$ $1 [R=301,L]
|
265
|
-
```
|
266
|
-
|
267
|
-
Here are some tips to show you how to integrate the rewrite rules with
|
268
|
-
different CMS tools. There are four areas you need to look out for:
|
269
|
-
|
270
|
-
### 1. Keep a backup
|
271
|
-
|
272
|
-
If you use trailing slash redirects on an existing site, always keep a backup
|
273
|
-
of your `.htaccess` and test thoroughly on your staging server before using it on
|
274
|
-
a production server.
|
275
|
-
|
276
|
-
### 2. Don't replace existing rules, merge
|
277
|
-
|
278
|
-
For example, if you use CodeIgniter you may have existing URL rewrite rules like:
|
279
|
-
|
280
|
-
```apache
|
281
|
-
RewriteCond %{REQUEST_FILENAME} !-f
|
282
|
-
RewriteCond %{REQUEST_FILENAME} !-d
|
283
|
-
RewriteRule ^(.*)$ index.php/$1
|
284
|
-
```
|
285
|
-
|
286
|
-
Merge the above with H5BP rules below:
|
287
|
-
|
288
|
-
```apache
|
289
|
-
RewriteCond %{REQUEST_FILENAME} !-f
|
290
|
-
RewriteCond %{REQUEST_URI} !(\.[a-zA-Z0-9]{1,5}|/|#(.*))$
|
291
|
-
RewriteRule ^(.*)$ $1/ [R=301,L]
|
292
|
-
```
|
293
|
-
|
294
|
-
### 3. Be careful of the order
|
295
|
-
|
296
|
-
Make sure you test thoroughly in your staging environment. For the above
|
297
|
-
example, the order is add trailing slash first, and add your existing rule
|
298
|
-
after:
|
299
|
-
|
300
|
-
```apache
|
301
|
-
# this adds trailing slash
|
302
|
-
RewriteCond %{REQUEST_FILENAME} !-f
|
303
|
-
RewriteCond %{REQUEST_URI} !(\.[a-zA-Z0-9]{1,5}|/|#(.*))$
|
304
|
-
RewriteRule ^(.*)$ $1/ [R=301,L]
|
305
|
-
|
306
|
-
# this gets rid of index.php
|
307
|
-
RewriteCond %{REQUEST_FILENAME} !-f
|
308
|
-
RewriteCond %{REQUEST_FILENAME} !-d
|
309
|
-
RewriteRule ^(.*)$ index.php/$1
|
310
|
-
```
|
311
|
-
|
312
|
-
### 4. Double-check `RewriteBase` path is correct
|
313
|
-
|
314
|
-
Make sure your `RewriteBase` path points to the correct location and sits above
|
315
|
-
any rewrite rules. This usually happens to those have WordPress and ran the
|
316
|
-
auto install. For instance, if you have a site at `example.com/blog`, your
|
317
|
-
RewriteBase may look like:
|
318
|
-
|
319
|
-
```apache
|
320
|
-
RewriteBase /blog/
|
321
|
-
```
|
322
|
-
|
323
|
-
If you already have a working RewriteBase, keep that and don't remove it.
|
data/site/html5bp-docs/html.md
DELETED
@@ -1,170 +0,0 @@
|
|
1
|
-
[HTML5 Boilerplate homepage](http://html5boilerplate.com) | [Documentation
|
2
|
-
table of contents](README.md)
|
3
|
-
|
4
|
-
# The HTML
|
5
|
-
|
6
|
-
## Conditional `html` classes
|
7
|
-
|
8
|
-
A series of IE conditional comments apply the relevant IE-specific classes to
|
9
|
-
the `html` tag. This provides one method of specifying CSS fixes for specific
|
10
|
-
legacy versions of IE. While you may or may not choose to use this technique in
|
11
|
-
your project code, HTML5 Boilerplate's default CSS does not rely on it.
|
12
|
-
|
13
|
-
When using the conditional classes technique, applying classes to the `html`
|
14
|
-
element has several benefits:
|
15
|
-
|
16
|
-
* It avoids a [file blocking
|
17
|
-
issue](http://webforscher.wordpress.com/2010/05/20/ie-6-slowing-down-ie-8/)
|
18
|
-
discovered by Stoyan Stefanov and Markus Leptien.
|
19
|
-
* It avoids the need for an empty comment that also fixes the above issue.
|
20
|
-
* CMSes like WordPress and Drupal use the body class more heavily. This makes
|
21
|
-
integrating there a touch simpler.
|
22
|
-
* It still validates as HTML5.
|
23
|
-
* It uses the same element as Modernizr (and Dojo). That feels nice.
|
24
|
-
* It can improve the clarity of code in multi-developer teams.
|
25
|
-
|
26
|
-
|
27
|
-
## The `no-js` class
|
28
|
-
|
29
|
-
Allows you to more easily explicitly add custom styles when JavaScript is
|
30
|
-
disabled (`no-js`) or enabled (`js`). More here: [Avoiding the
|
31
|
-
FOUC](http://paulirish.com/2009/avoiding-the-fouc-v3/).
|
32
|
-
|
33
|
-
|
34
|
-
## The order of meta tags, and `<title>`
|
35
|
-
|
36
|
-
As recommended by [the HTML5
|
37
|
-
spec](http://www.whatwg.org/specs/web-apps/current-work/complete/semantics.html#charset)
|
38
|
-
(4.2.5.5 Specifying the document's character encoding), add your charset
|
39
|
-
declaration early (before any ASCII art ;) to avoid a potential
|
40
|
-
[encoding-related security
|
41
|
-
issue](http://code.google.com/p/doctype/wiki/ArticleUtf7) in IE. It should come
|
42
|
-
in the first [1024
|
43
|
-
bytes](http://www.whatwg.org/specs/web-apps/current-work/multipage/semantics.html#charset).
|
44
|
-
|
45
|
-
The charset should also come before the `<title>` tag, due to [potential XSS
|
46
|
-
vectors](http://code.google.com/p/doctype-mirror/wiki/ArticleUtf7).
|
47
|
-
|
48
|
-
The meta tag for compatibility mode [needs to be before all elements except
|
49
|
-
title and meta](http://h5bp.com/f "Defining Document Compatibility - MSDN").
|
50
|
-
And that same meta tag can only be invoked for Google Chrome Frame if it is
|
51
|
-
within the [first 1024
|
52
|
-
bytes](http://code.google.com/p/chromium/issues/detail?id=23003).
|
53
|
-
|
54
|
-
|
55
|
-
## X-UA-Compatible
|
56
|
-
|
57
|
-
This makes sure the latest version of IE is used in versions of IE that contain
|
58
|
-
multiple rendering engines. Even if a site visitor is using IE8 or IE9, it's
|
59
|
-
possible that they're not using the latest rendering engine their browser
|
60
|
-
contains. To fix this, use:
|
61
|
-
|
62
|
-
```html
|
63
|
-
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
64
|
-
```
|
65
|
-
|
66
|
-
The `meta` tag tells the IE rendering engine two things:
|
67
|
-
|
68
|
-
1. It should use the latest, or edge, version of the IE rendering environment
|
69
|
-
2. If already installed, it should use the Google Chrome Frame rendering
|
70
|
-
engine.
|
71
|
-
|
72
|
-
This `meta` tag ensures that anyone browsing your site in IE is treated to the
|
73
|
-
best possible user experience that their browser can offer.
|
74
|
-
|
75
|
-
This line breaks validation, and the Google Chrome Frame part won't work inside
|
76
|
-
a conditional comment. To avoid these edge case issues it is recommended that
|
77
|
-
you **remove this line and use the `.htaccess`** (or other server config)
|
78
|
-
to send these headers instead. You also might want to read [Validating:
|
79
|
-
X-UA-Compatible](http://groups.google.com/group/html5boilerplate/browse_thread/thread/6d1b6b152aca8ed2).
|
80
|
-
|
81
|
-
If you are serving your site on a non-standard port, you will need to set this
|
82
|
-
header on the server-side. This is because the IE preference option 'Display
|
83
|
-
intranet sites in Compatibility View' is checked by default.
|
84
|
-
|
85
|
-
|
86
|
-
## Mobile viewport
|
87
|
-
|
88
|
-
There are a few different options that you can use with the [`viewport` meta
|
89
|
-
tag](https://docs.google.com/present/view?id=dkx3qtm_22dxsrgcf4 "Viewport and
|
90
|
-
Media Queries - The Complete Idiot's Guide"). You can find out more in [the
|
91
|
-
Apple developer docs](http://j.mp/mobileviewport). HTML5 Boilerplate comes with
|
92
|
-
a simple setup that strikes a good balance for general use cases.
|
93
|
-
|
94
|
-
```html
|
95
|
-
<meta name="viewport" content="width=device-width">
|
96
|
-
```
|
97
|
-
|
98
|
-
## Favicons and Touch Icons
|
99
|
-
|
100
|
-
The shortcut icons should be put in the root directory of your site. HTML5
|
101
|
-
Boilerplate comes with a default set of icons (include favicon and Apple Touch
|
102
|
-
Icons) that you can use as a baseline to create your own.
|
103
|
-
|
104
|
-
If your site or icons are in a sub-directory, you will need to reference the
|
105
|
-
icons using `link` elements placed in the HTML `head` of your document.
|
106
|
-
|
107
|
-
For a comprehensive overview, please read [Everything you always wanted to know
|
108
|
-
about touch icons](http://mathiasbynens.be/notes/touch-icons) by Mathias
|
109
|
-
Bynens.
|
110
|
-
|
111
|
-
|
112
|
-
## Modernizr
|
113
|
-
|
114
|
-
HTML5 Boilerplate uses a custom build of Modernizr.
|
115
|
-
|
116
|
-
[Modernizr](http://modernizr.com) is a JavaScript library which adds classes to
|
117
|
-
the `html` element based on the results of feature test and which ensures that
|
118
|
-
all browsers can make use of HTML5 elements (as it includes the HTML5 Shiv).
|
119
|
-
This allows you to target parts of your CSS and JavaScript based on the
|
120
|
-
features supported by a browser.
|
121
|
-
|
122
|
-
In general, in order to keep page load times to a minimum, it's best to call
|
123
|
-
any JavaScript at the end of the page because if a script is slow to load
|
124
|
-
from an external server it may cause the whole page to hang. That said, the
|
125
|
-
Modernizr script *needs* to run *before* the browser begins rendering the page,
|
126
|
-
so that browsers lacking support for some of the new HTML5 elements are able to
|
127
|
-
handle them properly. Therefore the Modernizr script is the only JavaScript
|
128
|
-
file synchronously loaded at the top of the document.
|
129
|
-
|
130
|
-
|
131
|
-
## The content area
|
132
|
-
|
133
|
-
The central part of the boilerplate template is pretty much empty. This is
|
134
|
-
intentional, in order to make the boilerplate suitable for both web page and
|
135
|
-
web app development.
|
136
|
-
|
137
|
-
### Google Chrome Frame
|
138
|
-
|
139
|
-
The main content area of the boilerplate includes a prompt to install Chrome
|
140
|
-
Frame (which no longer requires administrative rights) for users of IE 6. If
|
141
|
-
you intended to support IE 6, then you should remove the snippet of code.
|
142
|
-
|
143
|
-
### Google CDN for jQuery
|
144
|
-
|
145
|
-
The Google CDN version of the jQuery JavaScript library is referenced towards
|
146
|
-
the bottom of the page using a protocol-independent path (read more about this
|
147
|
-
in the [FAQ](faq.md). A local fallback of jQuery is included for rare instances
|
148
|
-
when the CDN version might not be available, and to facilitate offline
|
149
|
-
development.
|
150
|
-
|
151
|
-
Regardless of which JavaScript library you choose to use, it is well worth the
|
152
|
-
time and effort to look up and reference the Google CDN (Content Delivery
|
153
|
-
Network) version. Your users may already have this version cached in their
|
154
|
-
browsers, and Google's CDN is likely to deliver the asset faster than your
|
155
|
-
server.
|
156
|
-
|
157
|
-
### Google Analytics Tracking Code
|
158
|
-
|
159
|
-
Finally, an optimized version of the latest Google Analytics tracking code is
|
160
|
-
included. Google recommends that this script be placed at the top of the page.
|
161
|
-
Factors to consider: if you place this script at the top of the page, you’ll be
|
162
|
-
able to count users who don’t fully load the page, and you’ll incur the max
|
163
|
-
number of simultaneous connections of the browser.
|
164
|
-
|
165
|
-
Further information:
|
166
|
-
|
167
|
-
* [Optimizing the asynchronous Google Analytics
|
168
|
-
snippet](http://mathiasbynens.be/notes/async-analytics-snippet).
|
169
|
-
* [Tracking Site Activity - Google
|
170
|
-
Analytics](http://code.google.com/apis/analytics/docs/tracking/asyncTracking.html).
|
data/site/html5bp-docs/js.md
DELETED
@@ -1,31 +0,0 @@
|
|
1
|
-
[HTML5 Boilerplate homepage](http://html5boilerplate.com) | [Documentation
|
2
|
-
table of contents](README.md)
|
3
|
-
|
4
|
-
# The JavaScript
|
5
|
-
|
6
|
-
Information about the default JavaScript included in the project.
|
7
|
-
|
8
|
-
## main.js
|
9
|
-
|
10
|
-
This file can be used to contain or reference your site/app JavaScript code.
|
11
|
-
For larger projects, you can make use of a JavaScript module loader, like
|
12
|
-
[Require.js](http://requirejs.org/), to load any other scripts you need to
|
13
|
-
run.
|
14
|
-
|
15
|
-
## plugins.js
|
16
|
-
|
17
|
-
This file can be used to contain all your plugins, such as jQuery plugins and
|
18
|
-
other 3rd party scripts.
|
19
|
-
|
20
|
-
One approach is to put jQuery plugins inside of a `(function($){ ...
|
21
|
-
})(jQuery);` closure to make sure they're in the jQuery namespace safety
|
22
|
-
blanket. Read more about [jQuery plugin
|
23
|
-
authoring](http://docs.jquery.com/Plugins/Authoring#Getting_Started)
|
24
|
-
|
25
|
-
## vendor
|
26
|
-
|
27
|
-
This directory can be used to contain all 3rd party library code.
|
28
|
-
|
29
|
-
Minified versions of the latest jQuery and Modernizr libraries are included by
|
30
|
-
default. You may wish to create your own [custom Modernizr
|
31
|
-
build](http://www.modernizr.com/download/).
|
data/site/html5bp-docs/misc.md
DELETED
@@ -1,25 +0,0 @@
|
|
1
|
-
[HTML5 Boilerplate homepage](http://html5boilerplate.com) | [Documentation table of contents](README.md)
|
2
|
-
|
3
|
-
# Miscellaneous
|
4
|
-
|
5
|
-
## .gitignore
|
6
|
-
|
7
|
-
HTML5 Boilerplate includes a basic project-level `.gitignore`. This should
|
8
|
-
primarily be used to avoid certain project-level files and directories from
|
9
|
-
being kept under source control. Different development-environments will
|
10
|
-
benefit from different collections of ignores.
|
11
|
-
|
12
|
-
OS-specific and editor-specific files should be ignored using a "global
|
13
|
-
ignore" that applies to all repositories on your system.
|
14
|
-
|
15
|
-
For example, add the following to your `~/.gitconfig`, where the `.gitignore`
|
16
|
-
in your HOME directory contains the files and directories you'd like to
|
17
|
-
globally ignore:
|
18
|
-
|
19
|
-
```gitignore
|
20
|
-
[core]
|
21
|
-
excludesfile = ~/.gitignore
|
22
|
-
```
|
23
|
-
|
24
|
-
* More on global ignores: http://help.github.com/ignore-files/
|
25
|
-
* Comprehensive set of ignores on GitHub: https://github.com/github/gitignore
|
data/site/html5bp-docs/usage.md
DELETED
@@ -1,109 +0,0 @@
|
|
1
|
-
[HTML5 Boilerplate homepage](http://html5boilerplate.com) | [Documentation
|
2
|
-
table of contents](README.md)
|
3
|
-
|
4
|
-
# Usage
|
5
|
-
|
6
|
-
Once you have cloned or downloaded HTML5 Boilerplate, creating a site or app
|
7
|
-
usually involves the following:
|
8
|
-
|
9
|
-
1. Set up the basic structure of the site.
|
10
|
-
2. Add some content, style, and functionality.
|
11
|
-
3. Run your site locally to see how it looks.
|
12
|
-
4. (Optionally run a build script to automate the optimization of your site -
|
13
|
-
e.g. [ant build script](https://github.com/h5bp/ant-build-script) or [node
|
14
|
-
build script](https://github.com/h5bp/node-build-script)).
|
15
|
-
5. Deploy your site.
|
16
|
-
|
17
|
-
|
18
|
-
## Basic structure
|
19
|
-
|
20
|
-
A basic HTML5 Boilerplate site initially looks something like this:
|
21
|
-
|
22
|
-
```
|
23
|
-
.
|
24
|
-
├── css
|
25
|
-
│ ├── main.css
|
26
|
-
│ └── normalize.css
|
27
|
-
├── doc
|
28
|
-
├── img
|
29
|
-
├── js
|
30
|
-
│ ├── main.js
|
31
|
-
│ ├── plugins.js
|
32
|
-
│ └── vendor
|
33
|
-
│ ├── jquery.min.js
|
34
|
-
│ └── modernizr.min.js
|
35
|
-
├── .htaccess
|
36
|
-
├── 404.html
|
37
|
-
├── index.html
|
38
|
-
├── humans.txt
|
39
|
-
├── robots.txt
|
40
|
-
├── crossdomain.xml
|
41
|
-
├── favicon.ico
|
42
|
-
└── [apple-touch-icons]
|
43
|
-
```
|
44
|
-
|
45
|
-
What follows is a general overview of each major part and how to use them.
|
46
|
-
|
47
|
-
### css
|
48
|
-
|
49
|
-
This directory should contain all your project's CSS files. It includes some
|
50
|
-
initial CSS to help get you started from a solid foundation. [About the
|
51
|
-
CSS](css.md).
|
52
|
-
|
53
|
-
### doc
|
54
|
-
|
55
|
-
This directory contains all the HTML5 Boilerplate documentation. You can use it
|
56
|
-
as the location and basis for your own project's documentation.
|
57
|
-
|
58
|
-
### js
|
59
|
-
|
60
|
-
This directory should contain all your project's JS files. Libraries, plugins,
|
61
|
-
and custom code can all be included here. It includes some initial JS to help
|
62
|
-
get you started. [About the JavaScript](js.md).
|
63
|
-
|
64
|
-
### .htaccess
|
65
|
-
|
66
|
-
The default web server config is for Apache. [About the .htaccess](htaccess.md).
|
67
|
-
|
68
|
-
Host your site on a server other than Apache? You're likely to find the
|
69
|
-
corresponding configuration file in our [server configs
|
70
|
-
repo](https://github.com/h5bp/server-configs). If you cannot find a
|
71
|
-
configuration file for your setup, please consider contributing one so that
|
72
|
-
others can benefit too.
|
73
|
-
|
74
|
-
### 404.html
|
75
|
-
|
76
|
-
A helpful custom 404 to get you started.
|
77
|
-
|
78
|
-
### index.html
|
79
|
-
|
80
|
-
This is the default HTML skeleton that should form the basis of all pages on
|
81
|
-
your site. If you are using a server-side templating framework, then you will
|
82
|
-
need to integrate this starting HTML with your setup.
|
83
|
-
|
84
|
-
Make sure that you update the URLs for the referenced CSS and JavaScript if you
|
85
|
-
modify the directory structure at all.
|
86
|
-
|
87
|
-
If you are using Google Analytics, make sure that you edit the corresponding
|
88
|
-
snippet at the bottom to include your analytics ID.
|
89
|
-
|
90
|
-
### humans.txt
|
91
|
-
|
92
|
-
Edit this file to include the team that worked on your site/app, and the
|
93
|
-
technology powering it.
|
94
|
-
|
95
|
-
### robots.txt
|
96
|
-
|
97
|
-
Edit this file to include any pages you need hidden from search engines.
|
98
|
-
|
99
|
-
### crossdomain.xml
|
100
|
-
|
101
|
-
A template for working with cross-domain requests. [About
|
102
|
-
crossdomain.xml](crossdomain.md).
|
103
|
-
|
104
|
-
### icons
|
105
|
-
|
106
|
-
Replace the default `favicon.ico` and apple touch icons with your own. You
|
107
|
-
might want to check out Hans Christian's handy [HTML5 Boilerplate Favicon and
|
108
|
-
Apple Touch Icon
|
109
|
-
PSD-Template](http://drublic.de/blog/html5-boilerplate-favicons-psd-template/).
|