updated readme

albogdano · albogdano · commit 96a7a180457b · 2014-04-07T23:37:35.000+03:00
diff --git a/.jshintrc b/.jshintrc
@@ -9,5 +9,7 @@
   "undef": true,
   "boss": true,
   "eqnull": true,
-  "node": true
+  "node": true,
+  "quotmark": "double",
+  "trailing": false
 }
diff --git a/Gruntfile.js b/Gruntfile.js
@@ -9,70 +9,85 @@
 module.exports = function(grunt) {
 
 	var cssCopy = {
-		flatten: true, 
-		expand: true, 
-		cwd: "<%= site.templates %>/<%= site.template %>/css/", 
-		src: ["*.*"], 
+		flatten: true,
+		expand: true,
+		cwd: "<%= site.templates %>/<%= site.template %>/css/",
+		src: ["*.*"],
 		dest: "<%= site.dest %>/css/"
 	};
-	
+
 	var jsCopy = {
-		flatten: true, 
-		expand: true, 
-		cwd: "<%= site.templates %>/<%= site.template %>/js/", 
-		src: ["*.*"], 
+		flatten: true,
+		expand: true,
+		cwd: "<%= site.templates %>/<%= site.template %>/js/",
+		src: ["*.*"],
 		dest: "<%= site.dest %>/js/"
 	};
-	
+
 	var templateDir = "<%= site.templates %>/<%= site.template %>";
-	
+
 	// Project configuration.
 	grunt.initConfig({
 		pkg: grunt.file.readJSON("package.json"),
 		site: grunt.file.readJSON("assemble.json"),
 		vendor: grunt.file.readJSON(".bowerrc").directory,
 		h5bp: "<%= vendor %>/h5bp",
-		// Lint JavaScript
-		jshint: {
-			all: ["Gruntfile.js", "<%= site.helpers %>/*.js"],
-			options: {
-				jshintrc: ".jshintrc"
-			}
-		},
 		// Build HTML from templates and data
 		assemble: {
 			options: {
 				flatten: true,
 				layouts: "<%= site.layouts %>",
 				layout: "<%= site.layout %>",
-				partials: ["<%= site.partials %>/*.html", templateDir + "/partials/*.html"],
+				plugins: ["<%= site.plugins %>/*.js"],
+				helpers: ["<%= site.helpers %>/*.js"],
+				partials: ["<%= site.partials %>/*.{html,md}", templateDir + "/partials/*.{html,md}"],
 				template: "<%= site.template %>",
+				templateDir: templateDir,
 				// Metadata
 				pkg: "<%= pkg %>",
-				site: "<%= site %>",
-				data: ["<%= site.data %>"]
+				site: "<%= site %>"
 			},
 			htmls: {
 				files: {"<%= site.dest %>/": [templateDir + "/*.html"]}
+//				data: {},
+//				partials: [],
+//				pages: { page: { }}
 			},
 			phps: ("<%= assemble.options.template %>" === "modern-business") ? {
-				options: {
-					ext: ".php"
-				},
-				files: {"<%= site.dest %>/": [templateDir + "/contact.php"]}
+				options: {ext: ".php"},
+				files: { "<%= site.dest %>/": [templateDir + "/contact.php"] }
 			} : {}
 		},
+		// Lint JavaScript
+		jshint: {
+			all: ["Gruntfile.js", "<%= site.helpers %>/{,*/}*.js", "<%= site.plugins %>/{,*/}*.js"],
+			options: {
+				jshintrc: ".jshintrc"
+			}
+		},
+		// Validate HTML
+		validation: {
+			options: {
+				reset: true,
+				stoponerror: false,
+				reportpath: false,
+				relaxerror: ["Bad value X-UA-Compatible for attribute http-equiv on element meta."] //ignores these errors
+			},
+			files: {
+				src: ["<%= site.dest %>/{,*/}*.html"]
+			}
+		},
 		// Prettify test HTML pages from Assemble task.
 		prettify: {
 			all: {
 				files: [
 					{expand: true, cwd: "<%= site.dest %>", src: ["*.html"], dest: "<%= site.dest %>/", ext: ".html"}
 				]
 			}
-		},		
+		},
 		// concat and minify scripts
 		uglify: {
-		},		
+		},
 		// Copy H5BP files to new project, using replacement
 		// patterns to convert files into templates.
 		copy: {
@@ -81,7 +96,7 @@ module.exports = function(grunt) {
 //					{flatten: true, expand: true, cwd: "<%= vendor %>/h5bp/", src: ["doc/**"], dest: "tmp/content/"}
 					cssCopy, jsCopy,
 					{flatten: true, expand: true, cwd: templateDir + "/img/", src: ["*.*"], dest: "<%= site.dest %>/img/"},
-					{flatten: true, expand: true, cwd: templateDir + "/", src: ["*.html", "*.php"], dest: "<%= site.dest %>/"}					
+					{flatten: true, expand: true, cwd: templateDir + "/", src: ["*.html", "*.php"], dest: "<%= site.dest %>/"}
 				]
 			},
 			essentials: {
@@ -100,10 +115,10 @@ module.exports = function(grunt) {
 		clean: {
 			dest: ["<%= site.dest %>/**"]
 		},
-		
+
 		watch: {
 			assemble: {
-				files: [templateDir + "/{,*/}*.{md,yml,html}"],
+				files: [templateDir + "/{,*/}*.{md,yml,html}", "<%= site.layouts %>/*.html"],
 				tasks: ["assemble"]
 			},
 			css: {
@@ -155,13 +170,15 @@ module.exports = function(grunt) {
 	grunt.loadNpmTasks("grunt-contrib-jshint");
 	grunt.loadNpmTasks("grunt-contrib-watch");
 	grunt.loadNpmTasks("grunt-contrib-connect");
+	grunt.loadNpmTasks("grunt-html-validation");
 	grunt.loadNpmTasks("grunt-prettify");
 
 	// Default tasks to be run.
 	grunt.registerTask("default", ["test", "copy:content", "assemble", "copy:essentials", "prettify"]);
 
 	// Linting and tests.
-	grunt.registerTask("test", ["clean", "jshint"]);
-	grunt.registerTask("cb", ["clean", "default"]);	// clean & build
-	grunt.registerTask("server", ["cb", "connect:livereload", "watch"]); // watch & live reload
+	grunt.registerTask("test", ["clean"]);
+	grunt.registerTask("validate", ["jshint", "validation"]);	// html && js validation
+	grunt.registerTask("cb", ["default", "validate"]);	// clean & build
+	grunt.registerTask("server", ["default", "connect:livereload", "watch"]); // watch & live reload
 };
diff --git a/assemble.json b/assemble.json
@@ -1,13 +1,14 @@
 {
-  "dest": "dist",
-  "ga": "UA-XXXXX-X",
-  "domain": "domain.com",
-  "templates": "src",
-  "pages": "<%= site.templates %>/pages",
-  "partials": "<%= site.templates %>/partials",
-  "layouts": "<%= site.templates %>/layouts",
-  "layout": "default.html",
-  "data": "data/*.{json,yml}",
-  "template": "grayscale",
+	"dest": "dist",
+	"ga": "UA-XXXXX-X",
+	"domain": "domain.com",
+	"templates": "src",
+	"plugins": "<%= site.templates %>/plugins",
+	"helpers": "<%= site.templates %>/helpers",
+	"partials": "<%= site.templates %>/partials",
+	"layouts": "<%= site.templates %>/layouts",
+	"layout": "default.html",
+	"data": "<%= site.templates %>/data/*.{json,yml}",
+	"template": "monolite",
 	"theme": "flatly"
 }
diff --git a/package.json b/package.json
@@ -1,50 +1,58 @@
 {
-	"name": "bootup",
-	"description": "Website template with integrated Bootstrap, Assemble, HTML5 boilerplate and Bootswatch Simplex.",
-	"version": "0.2.0",
-	"homepage": "https://github.com/albogdano/bootup",
-	"author": {
-		"name": "Alex Bogdanovski",
-		"url": "https://github.com/albogdano"
-	},
-	"repository": {
-		"type": "git",
-		"url": "https://github.com/albogdano/bootup.git"
-	},
-	"bugs": {
-		"url": "https://github.com/albogdano/bootup/issues"
-	},
-	"licenses": [
-		{
-			"type": "MIT",
-			"url": "https://github.com/albogdano/bootup/blob/master/LICENSE-MIT"
-		}
-	],
-	"main": "Gruntfile.js",
-	"scripts": {
-		"test": "grunt test"
-	},
-	"devDependencies": {
-		"assemble": ">=0.4.37",
-		"grunt": ">=0.4.4",
-		"grunt-contrib-clean": ">=0.5.0",
-		"grunt-contrib-connect": ">=0.7.1",
-		"grunt-contrib-copy": ">=0.5.0",
-		"grunt-contrib-jshint": ">=0.8.0",
-		"grunt-contrib-qunit": ">=0.4.0",
-		"grunt-contrib-uglify": ">=0.4.0",
-		"grunt-contrib-watch": ">=0.5.3",
-		"grunt-prettify": ">=0.3.4"
-	},
-	"keywords": [
-		"assemble",
-		"assemble boilerplate",
-		"boilerplate",
-		"h5bp",
-		"html5 boilerplate",
-		"bootstrap",
-		"bootstrap boilerplate",
-		"bootup",
-		"bootswatch"
-	]
+  "name": "bootup",
+  "description": "Website template with integrated Bootstrap, Assemble, HTML5 boilerplate and Bootswatch themes.",
+  "version": "0.2.0",
+  "homepage": "https://github.com/albogdano/bootup",
+  "author": {
+    "name": "Alex Bogdanovski",
+    "url": "https://github.com/albogdano"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/albogdano/bootup.git"
+  },
+  "bugs": {
+    "url": "https://github.com/albogdano/bootup/issues"
+  },
+  "licenses": [
+    {
+      "type": "MIT",
+      "url": "https://github.com/albogdano/bootup/blob/master/LICENSE"
+    }
+  ],
+  "main": "Gruntfile.js",
+  "scripts": {
+    "test": "grunt test"
+  },
+  "devDependencies": {
+    "assemble": ">=0.4.37",
+    "grunt": ">=0.4.4",
+    "grunt-contrib-clean": ">=0.5.0",
+    "grunt-contrib-connect": ">=0.7.1",
+    "grunt-contrib-copy": ">=0.5.0",
+    "grunt-contrib-jshint": ">=0.8.0",
+    "grunt-contrib-uglify": ">=0.4.0",
+    "grunt-contrib-watch": ">=0.5.3",
+    "grunt-prettify": ">=0.3.4",
+    "grunt-html-validation": "^0.1.15",
+    "lodash": "^2.4.1",
+    "gray-matter": "^0.3.4",
+    "marked": "^0.3.2",
+    "minimatch": "^0.2.14",
+    "handlebars-helper-mdpartial": "*",
+    "assemble-partial-data": "*"
+  },
+  "keywords": [
+    "assemble",
+    "assemble boilerplate",
+    "boilerplate",
+    "h5bp",
+    "html5 boilerplate",
+    "bootstrap",
+    "bootstrap boilerplate",
+    "bootup",
+    "bootswatch",
+    "handlebars-helper-mdpartial",
+		"assemble-partial-data"
+  ]
 }
diff --git a/src/grayscale/index.html b/src/grayscale/index.html
@@ -63,4 +63,4 @@ <h2>Contact Start Bootstrap</h2>
 <div id="map"></div>
 
 <!-- Google Maps API Key - You will need to use your own API key to use the map feature -->
-<script type="text/javascript" src="https://maps.googleapis.com/maps/api/js?key=AIzaSyCRngKslUGJTlibkQ3FkfTxj3Xss1UlZDA&sensor=false"></script>
+<script type="text/javascript" src="https://maps.googleapis.com/maps/api/js?key=AIzaSyCRngKslUGJTlibkQ3FkfTxj3Xss1UlZDA&amp;sensor=false"></script>
diff --git a/src/grayscale/js/main.js b/src/grayscale/js/main.js
@@ -123,4 +123,4 @@ var myOptions = {
     }]
 };
 
-var map = new google.maps.Map(document.getElementById('map'), myOptions);
+var map = new google.maps.Map(document.getElementById("map"), myOptions);
diff --git a/src/layouts/default.html b/src/layouts/default.html
@@ -2,7 +2,7 @@
 <!--[if lt IE 7]>      <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
 <!--[if IE 7]>         <html class="no-js lt-ie9 lt-ie8"> <![endif]-->
 <!--[if IE 8]>         <html class="no-js lt-ie9"> <![endif]-->
-<!--[if gt IE 8]><!--> 
+<!--[if gt IE 8]><!-->
 <html lang="en-us" class="no-js"> <!--<![endif]-->
 	<head>
 		<meta charset="utf-8">
@@ -11,15 +11,14 @@
 		<meta name="description" content="{{description}}">
 		<meta name="viewport" content="width=device-width, initial-scale=1">
 
-		
 		{{#is site.theme "default"}}
 			<!-- Bootstrap Vanilla CSS -->
 			<link href="//netdna.bootstrapcdn.com/bootstrap/3.1.1/css/bootstrap.min.css" rel="stylesheet">
 		{{else}}
 			<!-- Bootswatch Theme CSS -->
 			<link href="//netdna.bootstrapcdn.com/bootswatch/3.1.1/{{site.theme}}/bootstrap.min.css" rel="stylesheet">
 		{{/is}}
-		
+
 		<link href="//netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.min.css" rel="stylesheet">
 		<!-- Place favicon.ico and apple-touch-icon.png in the root directory -->
 		<link href="css/main.css" rel="stylesheet">
@@ -28,16 +27,16 @@
 		<!--[if lt IE 7]>
 			<h1 class="browsehappy">You are using an <strong>outdated</strong> browser. Please <a href="http://browsehappy.com/">upgrade your browser</a> to improve your experience.</h1>
 		<![endif]-->
-		
+
 		<!--  Navigation  -->
 		{{>navbar}}
-		
+
 		<!-- Main Content -->
 		{{>body}}
 		
 		<!-- Footer Content -->
 		{{>footer}}
-		
+
 		<script src="//code.jquery.com/jquery.min.js"></script>
     <script src="//netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"></script>
 		<script src="js/main.js"></script>
diff --git a/src/modern-business/js/main.js b/src/modern-business/js/main.js
@@ -1,9 +1,9 @@
 // Activates the Carousel
-$('.carousel').carousel({
+$(".carousel").carousel({
   interval: 5000
 })
 
 // Activates Tooltips for Social Links
-$('.tooltip-social').tooltip({
+$(".tooltip-social").tooltip({
   selector: "a[data-toggle=tooltip]"
 })

Original file line number	Diff line number	Diff line change
`@@ -9,5 +9,7 @@`
`9`	`9`	`"undef": true,`
`10`	`10`	`"boss": true,`
`11`	`11`	`"eqnull": true,`
`12`		`- "node": true`
	`12`	`+ "node": true,`
	`13`	`+ "quotmark": "double",`
	`14`	`+ "trailing": false`
`13`	`15`	`}`