Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
  • 3 commits
  • 4 files changed
  • 0 comments
  • 1 contributor
4 CHANGELOG.md
Source Rendered
@@ -2,10 +2,10 @@
2 2
3 3 **v0.1.3** (July 11, 2013)
4 4
5   -* Added event propagation
  5 +* Small changes to improve performance and usability
6 6 * Updated default settings to be accessible `$.fn.navgoco.defaults.save = false;`
  7 +* Updated documentation and demo
7 8 * Updated tests
8   -* Updated documentation and demo.
9 9
10 10 **v0.1.2** (July 9, 2013)
11 11
25 CONTRIBUTING.md
Source Rendered
... ... @@ -1,25 +0,0 @@
1   -# Contributing
2   -
3   -### Code style
4   -Regarding code style like indentation and whitespace, **follow the conventions you see used in the source already.**
5   -
6   -## Modifying the code
7   -First, ensure that you have the latest [Node.js](http://nodejs.org/) and [npm](http://npmjs.org/) installed.
8   -
9   -Test that Grunt's CLI is installed by running `grunt --version`. If the command isn't found, run `npm install -g grunt-cli`. For more information about installing Grunt, see the [getting started guide](http://gruntjs.com/getting-started).
10   -
11   -1. Fork and clone the repo.
12   -1. Run `npm install` to install all dependencies (including Grunt).
13   -1. Run `grunt` to grunt this project.
14   -
15   -Assuming that you don't see any red, you're ready to go. Just be sure to run `grunt` after making any changes, to ensure that nothing is broken.
16   -
17   -## Submitting pull requests
18   -
19   -1. Create a new branch, please don't work in your `master` branch directly.
20   -1. Add failing tests for the change you want to make. Run `grunt` to see the tests fail.
21   -1. Fix stuff.
22   -1. Run `grunt` to see if the tests pass. Repeat steps 2-4 until done.
23   -1. Open `test/*.html` unit test file(s) in actual browser to ensure tests pass everywhere.
24   -1. Update the documentation to reflect any changes.
25   -1. Push to your fork and submit a pull request.
10 Gruntfile.js
... ... @@ -1,13 +1,8 @@
1 1 'use strict';
2 2
3 3 module.exports = function(grunt) {
4   -
5 4 grunt.util.linefeed = '\n';
6   -
7   - // Project configuration.
8 5 grunt.initConfig({
9   - // Metadata.
10   -
11 6 pkg: grunt.file.readJSON('navgoco.jquery.json'),
12 7 banner: '/*\n' +
13 8 ' * jQuery <%= pkg.title || pkg.name %> Plugin v<%= pkg.version %> (<%= grunt.template.today("yyyy-mm-dd") %>)\n' +
@@ -100,7 +95,6 @@ module.exports = function(grunt) {
100 95 },
101 96 });
102 97
103   - // These plugins provide necessary tasks.
104 98 grunt.loadNpmTasks('grunt-contrib-concat');
105 99 grunt.loadNpmTasks('grunt-contrib-clean');
106 100 grunt.loadNpmTasks('grunt-contrib-uglify');
@@ -109,8 +103,6 @@ module.exports = function(grunt) {
109 103 grunt.loadNpmTasks('grunt-contrib-watch');
110 104 grunt.loadNpmTasks('grunt-contrib-connect');
111 105
112   - // Register tasks.
113 106 grunt.registerTask('default', ['connect', 'clean', 'jshint', 'concat', 'uglify', 'qunit']);
114 107 grunt.registerTask('test', ['connect', 'jshint', 'qunit']);
115   -
116   -};
  108 +};
30 README.md
Source Rendered
@@ -6,7 +6,9 @@
6 6 Navgoco is a simple JQuery plugin which turns a nested unordered list of links
7 7 into a beautiful vertical multi-level slide navigation, with ability to preserve
8 8 expanded sub-menus between sessions by using cookies and optionally act as an accordion
9   -menu. **[Demo](http://apps.komposta.net/jquery/navgoco/demo)**
  9 +menu.
  10 +
  11 +**[Demo](http://apps.komposta.net/jquery/navgoco/demo)** | **[Homepage](http://www.komposta.net/article/navgoco)**
10 12
11 13 ## Getting Started
12 14 Download the plugin, unzip it and copy the files to your application directory and load them inside your HTML.
@@ -159,3 +161,29 @@ Destroy instances and unbind events.
159 161 // I can't think of any other use except for testing...
160 162 $(selector).navgoco('destroy');
161 163 ```
  164 +
  165 +## Contributing
  166 +
  167 +#### Code style
  168 +Regarding code style like indentation and whitespace, **follow the conventions you see used in the source already.**
  169 +
  170 +#### Modifying the code
  171 +First, ensure that you have the latest [Node.js](http://nodejs.org/) and [npm](http://npmjs.org/) installed.
  172 +
  173 +Test that Grunt's CLI is installed by running `grunt --version`. If the command isn't found, run `npm install -g grunt-cli`. For more information about installing Grunt, see the [getting started guide](http://gruntjs.com/getting-started).
  174 +
  175 +1. Fork and clone the repo.
  176 +1. Run `npm install` to install all dependencies (including Grunt).
  177 +1. Run `grunt` to grunt this project.
  178 +
  179 +Assuming that you don't see any red, you're ready to go. Just be sure to run `grunt` after making any changes, to ensure that nothing is broken.
  180 +
  181 +#### Submitting pull requests
  182 +
  183 +1. Create a new branch, please don't work in your `master` branch directly.
  184 +1. Add failing tests for the change you want to make. Run `grunt` to see the tests fail.
  185 +1. Fix stuff.
  186 +1. Run `grunt` to see if the tests pass. Repeat steps 2-4 until done.
  187 +1. Open `test/*.html` unit test file(s) in actual browser to ensure tests pass everywhere.
  188 +1. Update the documentation to reflect any changes.
  189 +1. Push to your fork and submit a pull request.

No commit comments for this range

Something went wrong with that request. Please try again.