Skip to content

Commit

Permalink
initial commit, cleaned up file org, new grunt and json files, remove…
Browse files Browse the repository at this point in the history
…d depr items
  • Loading branch information
Joseph Knox committed Sep 27, 2017
1 parent d586b2e commit bf13ac4
Show file tree
Hide file tree
Showing 246 changed files with 14,087 additions and 377 deletions.
54 changes: 8 additions & 46 deletions Gruntfile.js
Original file line number Diff line number Diff line change
@@ -1,64 +1,26 @@
/**
* @file
*/
module.exports = function(grunt) {

// This is where we configure each task that we'd like to run.
grunt.initConfig({
pkg: grunt.file.readJSON('package.json'),
availabletasks: {
tasks: {}
},
sasslint: {
options: {
configFile: '.sass-lint.yml'
},
target: ['core/\*\*/\*.scss']
},
sass: {
// This will compile all of our sass files
// Additional configuration options can be found at https://github.com/sindresorhus/grunt-sass
options: {
includePaths: [
"node_modules/bourbon/core",
"node_modules/bourbon-neat/core",
"node_modules/font-awesome/scss",
"node_modules/normalize.css",
"node_modules/neat-omega/core",
"node_modules",
"core"
],
sourceMap: true,
// This controls the compiled css and can be changed to nested, compact or compressed.
outputStyle: 'expanded',
precision: 10,
lineNumbers: true,
sourcemap: 'none'
},
dist: {
files: {
// 'examples/mixins/color-system/css/style.css': 'examples/mixins/color-system/scss/style.scss'
'css/decanter.css': 'scss/decanter.scss',
}
}
},
watch: {
css: {
files: [
'core/**/*.scss'
],
tasks: ['sass', 'sassdoc'],
options: {
interrupt: true
}
files: '**/*.scss',
tasks: ['sass']
}
}
});

// This is where we tell Grunt we plan to use this plug-in.
grunt.loadNpmTasks('grunt-available-tasks');
grunt.loadNpmTasks('grunt-sassdoc');
grunt.loadNpmTasks('grunt-sass-lint');
grunt.loadNpmTasks('grunt-sass');
grunt.loadNpmTasks('grunt-contrib-sass');
grunt.loadNpmTasks('grunt-contrib-watch');

// This is where we tell Grunt what to do when we type "grunt" into the terminal.
grunt.registerTask('default', ['availabletasks']);
};
grunt.registerTask('default', ['watch']);
}
76 changes: 1 addition & 75 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# [Decanter](https://github.com/SU-SWS/decanter)
##### Version: 0.0.0

Maintainers: [kgcreative](https://github.com/kgcreative), [sherakama](https://github.com/sherakama)
##### Version: 2.0.0

Changelog: [CHANGELOG.md](CHANGELOG.md)

Expand All @@ -16,75 +14,3 @@ Accessibility
[![WCAG Conformance 2.0 AA Badge](https://www.w3.org/WAI/wcag2AA-blue.png)](https://www.w3.org/TR/WCAG20/)
Evaluation Date: 201X-XX-XX
This project conforms to level AA WCAG 2.0 standards as required by the university's accessibility policy. For more information on the policy please visit: [https://ucomm.stanford.edu/policies/accessibility-policy.html](https://ucomm.stanford.edu/policies/accessibility-policy.html).

Installation
---

You can require this project as part of your project through NPM.

```
npm install su-sws/decanter --save-dev
```

If you are using a node based compiler you can tell the sass compiler to look
in to node_modules when using @import statements. Please see:
[https://github.com/sass/node-sass#includepaths](https://github.com/sass/node-sass#includepaths)

Grunt Example:
```javascript
module.exports = function(grunt) {
grunt.initConfig({
sass: {
// This will compile all of our sass files
// Additional configuration options can be found at https://github.com/sindresorhus/grunt-sass
options: {
includePaths: [
"node_modules/bourbon/core",
"node_modules/bourbon-neat/core",
"node_modules/decanter/core", // <-- this one will allow you to import decanter.
"node_modules"
],
sourceMap: true,
// This controls the compiled css and can be changed to nested, compact or compressed.
outputStyle: 'expanded',
precision: 10
},
dist: {
files: {
'css/my-stylesheet.css': 'scss/my-sass-sheet.scss'
}
}
}
})
};
```

Then in your sass files you can import any part of the project.

Example:

```sass
// Everything.
@import "decanter/main";
// Just a component.
@import "decanter/components/my-component";
```

Configuration
---

Please see [docs/CONFIGURATION.md](docs/CONFIGURATION.md) document.


Troubleshooting
---

If you are experiencing issues with this please have a look at the examples section first. If the examples fail to provide you the answer you are looking for please have a visit to the Github issue tracker. The issue tracker is not a personal support queue but rather, a place to post reproducible bugs.

Developer
---

If you wish to contribute to this project please see the [CONTRIBUTING.md](CONTRIBUTING.md) document for more information.

The development standards and best practices can be found in the (docs)[docs] section.
3 changes: 0 additions & 3 deletions core/decanter.scss

This file was deleted.

Loading

0 comments on commit bf13ac4

Please sign in to comment.