Permalink
Browse files

fix boilerplate metadata.

  • Loading branch information...
1 parent 2039262 commit c77166d3ba3878186e10d93594381beb1e3a7ab2 @jonschlinkert jonschlinkert committed Aug 20, 2013
Showing with 33 additions and 83 deletions.
  1. +1 −0 AUTHORS
  2. +8 −0 CHANGELOG
  3. +1 −0 CONTRIBUTING.md
  4. +3 −3 Gruntfile.js
  5. +12 −72 README.md
  6. +2 −2 bower.json
  7. +6 −6 package.json
View
@@ -0,0 +1 @@
+Jon Schlinkert (https://github.com/jonschlinkert/)
View
@@ -0,0 +1,8 @@
+v0.2.0:
+ date: 2013-08-03
+ changes:
+ - Refactored to build Bootstrap without having to manually edit the templates.
+v0.1.0:
+ date: 2013-07-16
+ changes:
+ - First commit.
View
@@ -0,0 +1 @@
+Please see the [Contributing to Assemble](http://assemble.io/contributing) guide for information on contributing to this project.
View
@@ -47,7 +47,7 @@ module.exports = function(grunt) {
// Refactor Liquid to Handlebars so we can
// build with Assemble instead of Jekyll
refactor: {
- liquid: {
+ bootstrap: {
options: {
replacements: '<%= replacements.regex.patterns %>'
},
@@ -99,15 +99,15 @@ module.exports = function(grunt) {
});
// These plugins provide necessary tasks.
+ grunt.loadNpmTasks('assemble');
grunt.loadNpmTasks('grunt-contrib-clean');
grunt.loadNpmTasks('grunt-contrib-copy');
grunt.loadNpmTasks('grunt-refactor');
- grunt.loadNpmTasks('assemble');
// Load local "Subgrunt" task to run Bootstrap's Gruntfile.
grunt.loadTasks('tasks');
- // Default task.
+ // Default task to be run with the "grunt" command.
grunt.registerTask('default', ['clean', 'subgrunt:js', 'subgrunt:css', 'copy', 'refactor', 'assemble']);
// Tests task.
View
@@ -1,6 +1,6 @@
-# boilerplate-bootstrap
+# boilerplate-bootstrap [![NPM version](https://badge.fury.io/js/boilerplate-bootstrap.png)](http://badge.fury.io/js/boilerplate-bootstrap)
-> Build [Bootstrap](https://github.com/twbs/bootstrap) with [Assemble][assemble] instead of Jekyll.
+> Build Bootstrap with Assemble instead of Jekyll. Assemble is a site-generator built as a Grunt.js plugin, so it runs entirely on Node.js.
#### [See it live →](http://assemble.github.io/boilerplate-bootstrap/)
@@ -23,80 +23,16 @@ _You must have [NPM](npmjs.org), [Bower][bower] and [Grunt][grunt] installed glo
```bash
npm i && bower install && cd vendor/bootstrap && npm i
```
+
You may now run `grunt` to build the project.
_Note that if you want to get the absolute latest, bleeding edge Bootstrap you will need to use `git clone https://github.com/twbs/bootstrap.git 'vendor/bootstrap'` instead of `bower install`._
-## The "assemble" task
-If you haven't used [Assemble][assemble] before, please visit [http://assemble.io/docs](http://assemble.io/docs) to learn how to customize the task.
-
-### Overview
-In the project's Gruntfile, the example `assemble` task is pre-loaded with paths and options to build the project successfully:
-
-```js
-assemble: {
- options: {
- site: '<%= site %>',
- flatten: true,
- assets: 'tmp/assets',
- partials: 'tmp/_includes/*.hbs',
- layoutdir: 'tmp/_layouts',
- layout: 'default.hbs'
- },
- docs: {
- src: ['tmp/*.hbs'],
- dest: 'tmp/'
- }
-}
-```
-
-<!--
-
-## Options #2
-
-```bash
-npm i assemble boilerplate-bootstrap --save-dev
-```
-
-Once this plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
-
-```bash
-grunt.loadNpmTasks('grunt-contrib-less');
-```
-
-## The "refactor" task
-
-This task converts Bootstrap's liquid templates to Handlebars templates. To use the task add the following configuration to the Gruntfile:
-
-```js
-// Regex for refactor task.
-replacements: require('./node_modules/boilerplate-bootstrap/tasks/replacements').init(grunt),
-
-// Refactor Liquid to Handlebars so we can
-// build with Assemble instead of Jekyll
-refactor: {
- liquid: {
- options: {
- replacements: '<%= replacements.regex.patterns %>'
- },
- files: [{
- expand: true,
- cwd: 'vendor/bootstrap',
- src: ['*.html', '_layouts/*.html', '_includes/*.html', '!js/**'],
- dest: '<%= site.destination %>/src/',
- ext: '.hbs'
- }
- ]
- }
-}
-```
-
-
-## The "assemble" task
+### The "assemble" task
If you haven't used [Assemble][assemble] before, please visit [http://assemble.io/docs](http://assemble.io/docs) to learn how to customize the task.
-### Overview
+#### Overview
In the project's Gruntfile, the example `assemble` task is pre-loaded with paths and options to build the project successfully:
```js
@@ -115,10 +51,8 @@ assemble: {
}
}
```
- -->
-
-## Author
+#### Author
**Jon Schlinkert**
@@ -135,6 +69,12 @@ In lieu of a formal styleguide, take care to maintain the existing coding style.
* 2013-07-16 v0.1.0 First commit.
+***
+
+
+Project authored by [Jon Schlinkert](https://github.com/jonschlinkert/).
+
+
[download]: https://github.com/assemble/boilerplate-bootstrap/archive/master.zip "Download boilerplate-bootstrap"
[helpers]: https://github.com/assemble/handlebars-helpers "Handlebars Helpers"
[assemble]: https://github.com/assemble/assemble/ "Assemble"
View
@@ -1,6 +1,6 @@
{
- "name": "assemble-bootstrap",
- "version": "0.2.0",
+ "name": "boilerplate-bootstrap",
+ "version": "0.2.1",
"main": [
"./Gruntfile.js"
],
View
@@ -1,8 +1,8 @@
{
- "name": "assemble-bootstrap",
- "description": "Build Bootstrap using Assemble instead of Jekyll. Assemble is a site-generator built as a Grunt.js plugin, so it runs entirely on Node.js.",
- "version": "0.2.0",
- "homepage": "https://github.com/assemble/assemble-bootstrap",
+ "name": "boilerplate-bootstrap",
+ "description": "Build Bootstrap with Assemble instead of Jekyll. Assemble is a site-generator built as a Grunt.js plugin, so it runs entirely on Node.js.",
+ "version": "0.2.1",
+ "homepage": "https://github.com/assemble/boilerplate-bootstrap",
"author": [
{
"name": "Jon Schlinkert",
@@ -11,10 +11,10 @@
],
"repository": {
"type": "git",
- "url": "https://github.com/assemble/assemble-bootstrap.git"
+ "url": "https://github.com/assemble/boilerplate-bootstrap.git"
},
"bugs": {
- "url": "https://github.com/assemble/assemble-bootstrap/issues"
+ "url": "https://github.com/assemble/boilerplate-bootstrap/issues"
},
"licenses": [
{

0 comments on commit c77166d

Please sign in to comment.