Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

massive updates to gruntfile, package.json, and README.md. Rebuilt

  • Loading branch information...
commit a9ed6696fa40d8aa9dbdf4c95d4a6e2485d9a0fd 1 parent f1f54d8
@jonschlinkert jonschlinkert authored
View
15 Gruntfile.js
@@ -13,33 +13,36 @@ module.exports = function(grunt) {
// Project configuration.
grunt.initConfig({
- config: grunt.file.readJSON('config.json'),
+ config: grunt.file.readJSON('src/config.json'),
+
// Build static files from templates and data.
assemble: {
options: {
helpers: '<%= config.helpers %>',
- assets: 'assets'
+ assets: 'docs/assets'
},
pages: {
options: {
layout : 'src/templates/layouts/default.hbs',
partials: 'src/templates/partials/**/*.hbs',
- data : ['src/data/cheatsheet.json', 'config.json']
+ data : ['src/data/cheatsheet.json', 'src/config.json']
},
files: {
- '.' : [ 'src/templates/pages/cheatsheet.hbs' ]
+ 'docs' : [ 'src/templates/pages/cheatsheet.hbs' ]
}
}
},
+
+
less: {
compile: {
options: {
paths: [ 'src/styles', 'src/styles/bootstrap']
},
files: {
- 'assets/css/cheatsheet.css': ['src/styles/cheatsheet.less'],
- 'assets/js/prettify/prettify.css': ['src/styles/components/prettify.less']
+ 'docs/assets/css/cheatsheet.css': ['src/styles/cheatsheet.less'],
+ 'docs/assets/js/prettify/prettify.css': ['src/styles/components/prettify.less']
}
}
},
View
32 README.md
@@ -1,14 +1,15 @@
-# toolkit-cheatsheet
+# Cheatsheet
+A UI component from [Upstage](http://github.com/upstage/upstage).
> Cheatsheet boilerplate. Created for the new [lesscss.org](http://lesscss.org) website (planned for later this year!), based on "[Shopify Cheat Sheet](http://cheat.markdunkley.com/)" by [Mark Dunkley](https://twitter.com/markdunkley).
-Live [demo here](http://assemble.github.com/toolkit-cheatsheet/).
+### See the [live demo][demo]
## Getting Started
If you want to modify this component, you may directly edit the source files: `.hbs` (Handlebars) templates, `.json` data, and `.less`. Or if you prefer you can grab the compiled HTML and CSS from `gh-pages` branch.
-To begin working with source files:
+To begin working with Cheat Sheet source files:
* Run `npm install` to install the depencies listed in `package.json`
* Run `grunt` to build the entire project
@@ -16,7 +17,6 @@ To begin working with source files:
* Run `grunt less` to compile LESS files to CSS
* Run `grunt watch` to watch source files for changes and re-build continuously
-
**Templates** for the cheatsheet are found here: `src/templates/**/*.hbs`.
**Styles** for the cheatsheet are found here: `src/styles/cheatsheet.less`.
@@ -25,27 +25,27 @@ To begin working with source files:
## Contributions
+Contributions welcome, and to make feature requests or report bugs, visit the [Issues][issues].
-Contributions welcome, and to make feature requests or report bugs, visit the [Issues](https://github.com/assemble/toolkit-cheatsheet/issues).
-
-To request a _new component_, please visit the [Toolkit Issues](http://github.com/assemble/toolkit/issues) page on GitHub.
-
-
-## About this Component
+To request a _new component_, please visit the [Upstage Issues][upstage-issues] page on GitHub.
-Cheatsheet is a [Toolkit](http://github.com/assemble/toolkit) component.
#### Grunt.js + Assemble
-Toolkit uses [Assemble](http://github.com/assemble/assemble), a Grunt.js plugin that makes it dead simple to build components with HTML, client-side templates, externalized data (JSON/YAML), and LESS.
+Upstage uses [Assemble](http://github.com/assemble/assemble), a Grunt.js plugin that makes it dead simple to build components with HTML, client-side templates, externalized data (JSON/YAML), and LESS.
#### Bootstrap Drop-in
-As with most Toolkit components, _cheatsheet_ is designed as a drop-in for [Bootstrap](http://twitter.github.com/bootstrap), but it can also be used on it's own.
-
+As with most Upstage components, _cheatsheet_ is designed as a drop-in for [Bootstrap](http://twitter.github.com/bootstrap), but it can also be used on it's own.
## Author
-+ Jon Schlinkert (@[jonschlinkert](http://github.com/jonschlinkert))
++ Jon Schlinkert, core team member for [LESS](http://github.com/cloudhead/less.js)
++ (@[jonschlinkert](http://github.com/jonschlinkert))
## License
-MIT
+MIT Licensed
+
+
+[demo]: http://github.com/upstage/cheatsheet/
+[issues]: http://github.com/upstage/cheatsheet/issues
+[upstage-issues]: http://github.com/upstage/upstage/issues
View
2  docs/cheatsheet.html
@@ -160,7 +160,7 @@ <h4 class="accordion-title">Mixins</h4>
<dt class="accordion-heading">
<a class="accordion-toggle" data-toggle="collapse" data-parent="#accordion3" href="#accordion3-toggle4">
<i class="toggle-chevron"></i>
- Basic
+ Implicit
</a>
</dt>
View
38 package.json
@@ -1,26 +1,21 @@
{
- "name": "toolkit-cheatsheet",
+ "name": "cheatsheet",
"description": "Cheatsheet boilerplate. Created for the new lesscss.org website, based on Shopify Cheat Sheet by Mark Dunkley.",
- "version": "0.1.2",
+ "version": "0.1.3",
"author": "Jon Schlinkert",
- "contributors": [
- {
- "name": "Jon Schlinkert",
- "url": "http://github.com/jonschlinkert"
- }
- ],
"repository": {
"type": "git",
- "url": "https://github.com/assemble/toolkit-cheatsheet.git"
+ "url": "https://github.com/upstage/cheatsheet.git"
},
"bugs": {
- "url": "https://github.com/assemble/toolkit-cheatsheet/issues"
+ "url": "https://github.com/upstage/cheatsheet/issues"
},
"engines": {
"node": ">= 0.8.0"
},
"devDependencies": {
- "assemble": "0.3.81",
+ "assemble": "0.3.9",
+ "assemble-styles": "0.2.0",
"grunt": "0.4.0",
"grunt-contrib-copy": "0.4.0",
"grunt-contrib-less": "0.5.0",
@@ -29,17 +24,20 @@
},
"keywords": [
"assemble",
- "boilerplate",
- "boilerplates",
- "bootstrap",
- "build system",
- "build",
- "builder",
+ "LESS",
+ "less css",
+ "sample cheatsheet",
+ "cheat sheet example",
+ "cheat sheet examples",
+ "github cheatsheet",
+ "markdown cheatsheet",
+ "handlebars cheatsheet",
+ "mustache cheatsheet",
+ "YAML cheatsheet",
"cheatsheet",
"cheat sheet",
- "component",
+ "UI component",
"components",
- "conventions",
"docs",
"documentation",
"framework",
@@ -54,6 +52,6 @@
"theme",
"themes",
"theming",
- "toolkit"
+ "upstage"
]
}
View
2  src/data/cheatsheet.json
@@ -47,7 +47,7 @@
"accordion-title": "Mixins",
"accordion-groups": [
{
- "topic-name": "Basic",
+ "topic-name": "Implicit",
"topic-summary": "This is a summary",
"topic-href": "<%= _.uniqueId('toggle') %>",
"label": false,
Please sign in to comment.
Something went wrong with that request. Please try again.