Merge pull request #6 from hlfcoding/v0.2.2

v0.2.2 - Numerous minor documentation improvements. - Switch to new pages template. - Rework tip stem positioning for hitbox accuracy. (5476c48) - Minor build task improvements.
hlfcoding · Jun 8, 2015 · 25314ad · 25314ad
2 parents a1b6d1d + 90c2ca8
commit 25314ad
Show file tree

Hide file tree

Showing 30 changed files with 308 additions and 225 deletions.
diff --git a/Gruntfile.coffee b/Gruntfile.coffee
@@ -8,13 +8,14 @@ aspects[name] = require "./build/#{name}" for name in [
 
 module.exports = (grunt) ->
 
-  grunt.initConfig
+  config =
     pkg: grunt.file.readJSON 'package.json'
 
     autoprefixer:
       options:
         browsers: ['last 2 versions', 'ie >= 8']
         cascade: yes
+        map: yes
       src: aspects.src.autoprefixer
       tests: aspects.tests.autoprefixer
 
@@ -31,6 +32,8 @@ module.exports = (grunt) ->
       release: aspects.release.clean
 
     coffee:
+      options:
+        sourceMap: yes
       src: aspects.src.coffee
       tests: aspects.tests.coffee
 
@@ -48,7 +51,8 @@ module.exports = (grunt) ->
     markdown:
       'gh-pages': aspects['gh-pages'].markdown
 
-    qunit: aspects.tests.qunit
+    qunit:
+      tests: aspects.tests.qunit
 
     sass:
       src: aspects.src.sass
@@ -60,10 +64,13 @@ module.exports = (grunt) ->
     watch:
       # Caveat: These watch tasks do not clean.
       css: aspects.src.watch.css
-      docs: aspects.docs.watch
       js: aspects.src.watch.js
       lib: aspects.lib.watch
 
+  config.watch.docs = aspects.docs.watch unless grunt.option('fast')?
+
+  grunt.initConfig config
+
   grunt.loadNpmTasks plugin for plugin in matchdep.filterDev 'grunt-*'
 
   grunt.registerTask 'default', ['lazy-dist', 'watch']

diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014-2015 Peng Wang
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
diff --git a/README.md b/README.md
@@ -1,12 +1,14 @@
-# HLF jQuery Library [![Build Status](https://travis-ci.org/hlfcoding/hlf-jquery.svg?branch=master)](https://travis-ci.org/hlfcoding/hlf-jquery) ![Bower Version](https://img.shields.io/bower/v/hlf-jquery.svg)
-
-     __         __       ___
-    /\ \       /\ \     / __\
-    \ \ \___   \ \ \   /\ \_/_
-     \ \  __`\  \ \ \  \ \  __\
-      \ \ \ \ \  \ \ \  \ \ \_/
-       \ \_\ \_\  \ \_\  \ \_\
-        \/_/ /_/   \/_/   \/_/
+# HLF jQuery Library [![Build Status](https://img.shields.io/travis/hlfcoding/hlf-jquery.svg)](https://travis-ci.org/hlfcoding/hlf-jquery) ![Bower Version](https://img.shields.io/bower/v/hlf-jquery.svg) ![GitHub License](https://img.shields.io/github/license/hlfcoding/hlf-jquery.svg)
+
+<pre>
+ __         __       ___
+/\ \       /\ \     / __\
+\ \ \___   \ \ \   /\ \_/_
+ \ \  __`\  \ \ \  \ \  __\
+  \ \ \ \ \  \ \ \  \ \ \_/
+   \ \_\ \_\  \ \_\  \ \_\
+    \/_/ /_/   \/_/   \/_/
+</pre>
 
 jQuery extensions and plugins for quality UI and implemented following best
 practices. The [annotated source code][] is also available and include
@@ -93,7 +95,7 @@ Main features:
 your-project> bower install hlf-jquery
 ```
 
-## Development [![devDependency Status](https://david-dm.org/hlfcoding/hlf-jquery/dev-status.svg)](https://david-dm.org/hlfcoding/hlf-jquery#info=devDependencies)
+## Development [![devDependency Status](https://img.shields.io/david/dev/hlfcoding/hlf-jquery.svg)](https://david-dm.org/hlfcoding/hlf-jquery#info=devDependencies)
 
 ```bash
 hlf-jquery> npm install
@@ -125,13 +127,15 @@ Note that Grunt task options and multi-tasks are in build/.
       "file_exclude_patterns":
       [
         "dist/*",
-        "docs/*",
+        "docs/index.html",
         "release/*",
         "tests/*.css",
         "tests/*.js"
       ],
       "folder_exclude_patterns":
       [
+        ".grunt",
+        "docs/*",
         "node_modules",
         "gh-pages"
       ]
@@ -144,25 +148,27 @@ Note that Grunt task options and multi-tasks are in build/.
 
 The MIT License (MIT)
 
-    Copyright (c) 2014-2015 Peng Wang
-
-    Permission is hereby granted, free of charge, to any person obtaining a
-    copy of this software and associated documentation files (the "Software"),
-    to deal in the Software without restriction, including without limitation
-    the rights to use, copy, modify, merge, publish, distribute, sublicense,
-    and/or sell copies of the Software, and to permit persons to whom the
-    Software is furnished to do so, subject to the following conditions:
-
-    The above copyright notice and this permission notice shall be included in
-    all copies or substantial portions of the Software.
-
-    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
-    DEALINGS IN THE SOFTWARE.
+<pre>
+Copyright (c) 2014-2015 Peng Wang
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
+</pre>
 
 [UMD]: https://github.com/umdjs/umd
 [annotated source code]: http://hlfcoding.github.io/hlf-jquery/docs/index.html

diff --git a/build/docs.coffee b/build/docs.coffee
@@ -5,19 +5,22 @@ grunt = require 'grunt'
 src = [
   'src/**/*.{coffee,scss}'
   'tests/**/*.{coffee,scss}'
-  'README.md'
+  'docs/README.md'
 ]
 
 module.exports =
 
   clean: [
-    'docs/*'
+    'docs/*/**'
     '!docs/.gitignore'
+    '!docs/README.md'
   ]
 
   groc:
     src: src
-    options: { out: 'docs/' }
+    options:
+      index: 'docs/README.md'
+      out: 'docs/'
 
   watch:
     files: src

diff --git a/build/gh-pages.coffee b/build/gh-pages.coffee
@@ -6,32 +6,51 @@ module.exports =
     options:
       base: 'gh-pages'
       add: yes
-    src: ['**']
+    src: [
+      '**'
+      '!template.jst.html'
+    ]
 
   clean: [
     'gh-pages/*'
     '!gh-pages/.gitignore'
-    '!gh-pages/template.html'
+    '!gh-pages/template.jst.html'
   ]
 
   copy:
-    expand: yes
-    src: [
-      'dist/**/*'
-      'docs/**/*'
-      'lib/**/*'
-      'tests/**/*'
-      '!tests/**/*.{scss,coffee}'
-      'README.md'
+    nonull: yes
+    files: [
+      {
+        expand: yes
+        src: [
+          'dist/**/*'
+          'docs/**/*'
+          'lib/**/*'
+          'tests/**/*'
+          '!tests/**/*.{scss,coffee}'
+          'README.md'
+        ]
+        dest: 'gh-pages/'
+      }
+      {
+        src: 'node_modules/merlot/template.jst.html'
+        dest: 'gh-pages/'
+      }
     ]
-    dest: 'gh-pages/'
 
   markdown:
     options:
       markdownOptions:
         gfm: yes
         highlight: 'auto'
-      template: 'gh-pages/template.html'
+      template: 'gh-pages/template.jst.html'
+      templateContext:
+        githubAuthor: 'hlfcoding'
+        githubPath: 'hlfcoding/hlf-jquery'
+        headline: 'HLF jQuery'
+        pageTitle: 'HLF jQuery by hlfcoding'
+        subHeadline: 'Custom jQuery Plugins'
+
     src: 'gh-pages/README.md'
     dest: 'gh-pages/index.html'
 

diff --git a/build/src.coffee b/build/src.coffee
@@ -1,16 +1,12 @@
 module.exports =
 
   autoprefixer:
-    options:
-      map: yes
     expand: yes
     src: 'dist/**/*.css'
     ext: '.css'
     extDot: 'last'
 
   coffee:
-    options:
-      sourceMap: yes
     expand: yes
     src: 'src/**/*.coffee'
     dest: 'dist/'
@@ -29,7 +25,7 @@ module.exports =
   watch:
     css:
       files: '{src,tests}/**/*.scss'
-      tasks: ['newer:copy:dist', 'newer:sass', 'newer:autoprefixer']
+      tasks: ['newer:copy:dist', 'sass', 'newer:autoprefixer']
     js:
       files: '{src,tests}/**/*.coffee'
-      tasks: ['newer:coffee']
+      tasks: ['newer:coffee', 'newer:qunit']
diff --git a/build/tests.coffee b/build/tests.coffee
@@ -3,21 +3,16 @@ grunt = require 'grunt'
 module.exports =
 
   qunit:
-    all:
-      expand: yes
-      src: 'tests/*.unit.html'
+    expand: yes
+    src: 'tests/*.unit.html'
 
   autoprefixer:
-    options:
-      map: yes
     expand: yes
     src: 'tests/**/*.css'
     ext: '.css'
     extDot: 'last'
 
   coffee:
-    options:
-      sourceMap: yes
     expand: yes
     src: 'tests/**/*.coffee'
     ext: '.js'

diff --git a/docs/.gitignore b/docs/.gitignore
@@ -1,2 +1,3 @@
 *
-!.gitignore
+!.gitignore
+!README.md
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,18 @@
+# HLF jQuery Documentation
+
+## Navigation
+
+Use the 'Table of Contents' on the right to navigate. Pages are organized as
+they are in the project's file structure. You can use search to quickly
+navigate, for example query 'Tip' to find all tip-related documentation.
+
+You'll also find links in the source files for the corresponding test files, and
+vice versa, since the tests also serve as usage examples for the source.
+
+## Generation
+
+The docs use [Groc](http://nevir.github.io/groc) and are generated via:
+
+```bash
+grunt docs
+```
diff --git a/gh-pages/.gitignore b/gh-pages/.gitignore
@@ -1,3 +1,3 @@
 *
 !.gitignore
-!template.html
+!template.jst.html