From 7089aa30feb873d2638a4c88b020a1f98ab61115 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Julian=20=C4=86wirko?= Date: Thu, 19 Nov 2015 22:20:10 +0100 Subject: [PATCH] Meteor package adjustments and atmospherejs.com docs --- meteor-README.md | 79 ++++++++++++++++++++++++++++++++++++++++++++++++ package.js | 13 +++----- 2 files changed, 84 insertions(+), 8 deletions(-) create mode 100644 meteor-README.md diff --git a/meteor-README.md b/meteor-README.md new file mode 100644 index 000000000..516119d27 --- /dev/null +++ b/meteor-README.md @@ -0,0 +1,79 @@ +# [Foundation for Sites](http://foundation.zurb.com) (v6.0) + +Foundation is the most advanced responsive front-end framework in the world. Quickly go from prototype to production, building sites or apps that work on any kind of device with Foundation. Includes layout constructs, like a fully customizable, responsive grid, commonly used JavaScript plugins, and full A11Y support. + +## Usage in Meteor + +### 1. Add the package + +``` +meteor add zurb:foundation-sites +``` + +### 2. In your main .scss file (in your app): + +Import foundation: + +``` +@import '{zurb:foundation-sites}/scss/foundation'; +``` + +Each component has an export mixin which prints out the CSS for that component. If you're cool with having everything, you just need one line of code: + +``` +@include foundation-everything; +``` + +Or you can comment out the components you don't need: + +``` +@include foundation-global-styles; +@include foundation-grid; +@include foundation-typography; +@include foundation-button; +@include foundation-forms; +@include foundation-visibility-classes; +@include foundation-float-classes; +@include foundation-accordion; +@include foundation-accordion-menu; +@include foundation-badge; +@include foundation-breadcrumbs; +@include foundation-button-group; +@include foundation-callout; +@include foundation-close-button; +@include foundation-drilldown-menu; +@include foundation-dropdown; +@include foundation-dropdown-menu; +@include foundation-flex-video; +@include foundation-label; +@include foundation-media-object; +@include foundation-menu; +@include foundation-off-canvas; +@include foundation-orbit; +@include foundation-pagination; +@include foundation-progress-bar; +@include foundation-slider; +@include foundation-sticky; +@include foundation-reveal; +@include foundation-switch; +@include foundation-table; +@include foundation-tabs; +@include foundation-thumbnail; +@include foundation-title-bar; +@include foundation-tooltip; +@include foundation-top-bar; +``` + +### 3. Overwrite Foundation settings + +If you want you can coppy `_settings.scss` file into your project. You can change settings and import it in your main .scss file (in your app): + +``` +@import 'settings'; // example when the _settings.scss file is in the same folder as your main .scss file +@import '{zurb:foundation-sites}/scss/foundation'; + +@include foundation-everything; // or individual ones + +``` + +**Important:** In the _settings.scss (the copied one in your app) you need to replace `@import 'util/util'` with `@import '{zurb:foundation-sites}/scss/util/util'` diff --git a/package.js b/package.js index 1f744b227..89671636f 100644 --- a/package.js +++ b/package.js @@ -1,19 +1,17 @@ Package.describe({ name: 'zurb:foundation-sites', summary: 'The most advanced responsive front-end framework in the world.', - version: '6.0.0', - git: 'https://github.com/zurb/foundation-sites.git' + version: '6.0.1', + git: 'https://github.com/zurb/foundation-sites.git', + documentation: 'meteor-README.md' }); Package.onUse(function(api) { api.versionsFrom('1.2.1'); api.imply('fourseven:scss@3.4.1'); api.use(['ecmascript', 'jquery@1.11.4', 'fourseven:scss@3.4.1'], 'client'); + api.addFiles('dist/foundation.js', 'client'); api.addFiles([ - 'dist/foundation.css', - 'dist/foundation.min.css', - 'dist/foundation.js', - 'dist/foundation.min.js', 'scss/foundation.scss', 'scss/_global.scss', @@ -32,7 +30,6 @@ Package.onUse(function(api) { 'scss/components/_dropdown.scss', 'scss/components/_flex-video.scss', 'scss/components/_float.scss', - 'scss/components/_joyride.scss', 'scss/components/_label.scss', 'scss/components/_media-object.scss', 'scss/components/_menu.scss', @@ -87,5 +84,5 @@ Package.onUse(function(api) { 'scss/util/_value.scss', 'scss/vendor/normalize.scss', - ], 'client'); + ], 'client', {isImport: true}); }); -- 2.47.2