Skip to content

Commit 46ab940

Browse files
brienpaffordbrienpafford
committed
framework
1 parent a5fdfce commit 46ab940

File tree

209 files changed

+36590
-16
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

209 files changed

+36590
-16
lines changed

‎CONTRIBUTING.md

+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Contributing to GroundworkCSS
2+
3+
Looking to contribute something to Groundwork? **Here's how you can help.**
4+
5+
6+
7+
## Reporting issues
8+
9+
1. **Create an isolated and reproducible test case.** Be sure the problem exists in the Groundwork code with a [reduced test case](http://css-tricks.com/reduced-test-cases/) that should be included in each bug report.
10+
2. **Include a live example.** Make use of jsFiddle or Codepen to share your isolated test cases.
11+
3. **Share as much information as possible.** Include operating system and version, browser and version, version of Groundwork, etc. where appropriate. Also include steps to reproduce the bug.
12+
13+
14+
15+
## Key branches
16+
17+
- `master` is the latest, deployed version
18+
- `grid` is the stand-alone grid system branch
19+
- `X.XX.X-wip` branches are the official work in progress branches for the next releases. All pull requests should be submitted against the appropriate branch
20+
21+
22+
23+
## Pull requests
24+
25+
- Submit all pull requests against the appropriate `*-wip` branch for easier merging
26+
- CSS changes must be done in the .sass files first, never the compiled files
27+
- HTML changes must be done in the .jade template files first, never the compiled files
28+
- When modifying any source files (.sass, .jade, coffee, etc.), always recompile and commit the compiled files by using the Grunt tasks `grunt build`
29+
- Try not to pollute your pull request with unintended changes -- keep them simple and small (minimize unecessary diffs)
30+
- Try to share which browsers your code has been tested in before submitting a pull request
31+
32+
33+
34+
## Coding standards: HTML
35+
36+
- Two spaces for indentation, never tabs
37+
- Double quotes only, never single quotes
38+
- Always use proper indentation
39+
- Use tags and elements appropriate for an HTML5 doctype (e.g., self-closing tags)
40+
41+
42+
43+
## Coding standards: CSS
44+
45+
- Multiple-line approach (one property and value per line)
46+
- Always a space after a property's colon (.e.g, `display: block;` and not `display:block;`)
47+
- End all lines with a semi-colon
48+
- For multiple, comma-separated selectors, place each selector on it's own line
49+
- Use of .sass comments are okay when necessary ("//"), but do not use CSS comments ("/* */")
50+
- Attribute selectors, like `input[type="text"]` should always wrap the attribute's value in double quotes, for consistency and safety (see this [blog post on unquoted attribute values](http://mathiasbynens.be/notes/unquoted-attribute-values) that can lead to XSS attacks)
51+
52+
53+
54+
## License
55+
56+
By contributing your code, you agree to license your contribution under the terms of the MIT License:
57+
- http://opensource.org/licenses/mit-license.html

‎Gruntfile.coffee

+79
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
module.exports = (grunt) ->
2+
3+
grunt.initConfig
4+
pkg: grunt.file.readJSON("package.json")
5+
6+
watch:
7+
jade:
8+
files: '**/*.jade'
9+
tasks: ['jade']
10+
compass:
11+
files: '**/*.sass'
12+
tasks: ['compass', 'autoprefixer', 'cssmin']
13+
coffee:
14+
files: '**/*.coffee'
15+
tasks: ['coffee', 'uglify']
16+
17+
jade:
18+
build:
19+
options:
20+
pretty: true
21+
files: [
22+
expand: true
23+
cwd: 'src/jade'
24+
src: ['**/*.jade', '!template.jade']
25+
dest: 'docs'
26+
ext: '.html'
27+
]
28+
29+
compass:
30+
build:
31+
options:
32+
config: 'config.rb'
33+
trace: true
34+
35+
autoprefixer:
36+
build:
37+
options:
38+
browsers: ['last 2 versions']
39+
files:
40+
'css/groundwork.css': ['css/groundwork.css']
41+
42+
coffee:
43+
individual:
44+
expand: true
45+
cwd: 'src/coffee'
46+
src: ['**/*.coffee', '!groundwork.all.coffee']
47+
dest: 'js'
48+
ext: '.js'
49+
concatenated:
50+
options:
51+
join: true
52+
files:
53+
"js/groundwork.all.js": ["src/coffee/components/*.coffee", "src/coffee/plugins/*.coffee"]
54+
55+
uglify:
56+
minify:
57+
files:
58+
'js/groundwork.all.js': ['js/groundwork.all.js']
59+
60+
cssmin:
61+
minify:
62+
expand: true
63+
cwd: 'css/'
64+
src: ['*.css', '!*.min.css']
65+
dest: 'css/'
66+
ext: '.css'
67+
68+
grunt.loadNpmTasks 'grunt-contrib-watch'
69+
grunt.loadNpmTasks 'grunt-contrib-coffee'
70+
grunt.loadNpmTasks 'grunt-contrib-jade'
71+
grunt.loadNpmTasks 'grunt-contrib-sass'
72+
grunt.loadNpmTasks 'grunt-contrib-compass'
73+
grunt.loadNpmTasks 'grunt-autoprefixer'
74+
grunt.loadNpmTasks 'grunt-contrib-cssmin'
75+
grunt.loadNpmTasks 'grunt-contrib-uglify'
76+
77+
grunt.registerTask 'default', ['build']
78+
grunt.registerTask 'build', ['compass', 'autoprefixer', 'coffee:individual', 'coffee:concatenated', 'cssmin', 'uglify']
79+
grunt.registerTask 'docs', ['jade']

‎LICENSE

100644100755
+14-16
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,20 @@
1-
The MIT License (MIT)
1+
(The MIT License)
22

3-
Copyright (c) 2015 Brien Pafford
3+
Copyright (c) 2013 Gary Hepting <[email protected]>
44

5-
Permission is hereby granted, free of charge, to any person obtaining a copy
6-
of this software and associated documentation files (the "Software"), to deal
7-
in the Software without restriction, including without limitation the rights
8-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9-
copies of the Software, and to permit persons to whom the Software is
10-
furnished to do so, subject to the following conditions:
5+
Permission is hereby granted, free of charge, to any person obtaining a copy of
6+
this software and associated documentation files (the 'Software'), to deal in
7+
the Software without restriction, including without limitation the rights to
8+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
9+
the Software, and to permit persons to whom the Software is furnished to do so,
10+
subject to the following conditions:
1111

1212
The above copyright notice and this permission notice shall be included in all
1313
copies or substantial portions of the Software.
1414

15-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21-
SOFTWARE.
22-
15+
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
17+
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
18+
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
19+
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20+
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

‎README.md

+99
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
![Groundwork Logo](https://0.gravatar.com/avatar/c8ae740c0b5f7dd913308974a07ee02c?s=150)
2+
3+
GroundworkCSS 2.5.0
4+
====
5+
6+
Say hello to responsive design made easy.
7+
8+
[http://groundworkcss.github.io](http://groundworkcss.github.io)
9+
10+
[GroundworkCSS](http://groundworkcss.github.io) is a fully responsive HTML5, CSS
11+
and Javascript toolkit created by [@ghepting](http://twitter.com/ghepting).
12+
13+
Using GroundworkCSS, you can rapidly prototype and create accessible web apps that
14+
work on virtually any device. Key features that make GroundworkCSS stand out are:
15+
16+
* nestable, fractional, responsive, adaptive, fluid grid system
17+
* works on virtually anything: mobile, tablet, or large screen devices
18+
* built with modular Sass and CoffeeScript components
19+
* easy to customize
20+
* highly configurable
21+
* supports purely semantic implementations by utilizing Sass @extend, @mixin and
22+
%placeholder classes
23+
* built-in ARIA role support
24+
* responsive text and tables
25+
* and much more
26+
27+
Getting Started using GroundworkCSS
28+
====
29+
30+
Default Build
31+
----
32+
33+
The easiest way to incorporate GroundworkCSS into your project is to copy the
34+
pre-compiled CSS and JS files into your project, and then refer to them in
35+
markup. The 2 most important files are:
36+
37+
* css/groundwork.css
38+
* js/groundwork.all.js
39+
40+
In addition to these (required) support files:
41+
42+
* js/libs/modernizr-2.6.2.min.js (required)
43+
* js/libs/jquery-1.10.2.min.js (required)
44+
* css/groundwork-ie.css (required for old IE compatibility)
45+
46+
All in all, you may end up with markup that looks like the following:
47+
48+
**At the top of your HTML document (within the head section)**
49+
50+
<!-- Modernizr -->
51+
<script src="/js/libs/modernizr-2.6.2.min.js"></script>
52+
<!-- framework css -->
53+
<!--[if gt IE 9]><!-->
54+
<link type="text/css" rel="stylesheet" href="/css/groundwork.css">
55+
<!--<![endif]-->
56+
<!--[if lte IE 9]>
57+
<link type="text/css" rel="stylesheet" href="/css/groundwork-core.css">
58+
<link type="text/css" rel="stylesheet" href="/css/groundwork-type.css">
59+
<link type="text/css" rel="stylesheet" href="/css/groundwork-ui.css">
60+
<link type="text/css" rel="stylesheet" href="/css/groundwork-anim.css">
61+
<link type="text/css" rel="stylesheet" href="/css/groundwork-ie.css">
62+
<![endif]-->
63+
64+
**At the bottom of your HTML document (just before your closing body tag)**
65+
66+
<script type="text/javascript" src="/js/libs/jquery-1.10.2.min.js"></script>
67+
<script type="text/javascript" src="/js/groundwork.all.js"></script>
68+
69+
70+
Custom Build
71+
----
72+
73+
If you use Sass and you want to compile your own build of Groundwork or
74+
integrate it along with your project code.
75+
76+
Sass source files are located in **src/sass** and **src/coffee**.
77+
78+
Important files to edit are:
79+
80+
* groundwork.sass: dictates which modules are imported for compilation
81+
(delete/comment out unneeded modules).
82+
* _settings.sass: initial settings for Groundwork, including customizable
83+
colors, options to turn off rapid prototyping classes and much more.
84+
85+
You can then output your own groundwork[.css/.js], or import groundwork.sass
86+
as part of your project's Sass. The latter lets you utilise GroundworkCSS's
87+
library through ```@include``` or ```@extend``` for your custom classes.
88+
89+
90+
Ruby on Rails
91+
----
92+
93+
If you're using Groundwork in a Ruby on Rails project, definitely use the
94+
[groundworkcss-rails gem](http://github.com/groundworkcss/groundworkcss-rails)
95+
96+
97+
Want to develop on and contribute to GroundworkCSS?
98+
----
99+
Read [Contributing to Groundwork](https://github.com/groundworkcss/groundwork/wiki/Contributing-to-Groundwork) and fork away! :)

‎bower.json

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{
2+
"name" : "groundworkcss",
3+
"version" : "2.5.0",
4+
"main" : [
5+
"js/groundwork.all.js",
6+
"css/groundwork.css"
7+
],
8+
"ignore" : [
9+
"**/.*",
10+
"*.json",
11+
"*.rb",
12+
"css/demo",
13+
"js/demo",
14+
"Gruntfile.coffee",
15+
"node_modules"
16+
],
17+
"dependencies": {
18+
"jquery": "~1.10.2",
19+
"modernizr": "~2.6.2"
20+
}
21+
}

‎config.rb

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Set this to the root of your project
2+
http_path = "/"
3+
css_dir = "css"
4+
sass_dir = "src/sass"
5+
images_dir = "images"
6+
javascripts_dir = "js"
7+
fonts_dir = "fonts"
8+
9+
output_style = :expanded
10+
environment = :development
11+
12+
# To enable debug info. Uncomment:
13+
# if environment != :production
14+
# sass_options = {:debug_info => true}
15+
# end
16+
17+
# To enable relative paths to assets via compass helper functions. Uncomment:
18+
# relative_assets = true
19+
20+
line_comments = false
21+
color_output = false
22+
23+
# If you prefer the Sassy-CSS (SCSS) syntax, you might want to regenerate this
24+
# project again passing --syntax scss, or you can change preferred_syntax to ":scss":
25+
preferred_syntax = :sass
26+
# and then run:
27+
# sass-convert -R --from sass --to scss src/sass src/scss && rm -rf src/sass

0 commit comments

Comments
 (0)