Project page: http://gitgraphjs.com/
How to start
You have different options to start with the library:
- Download the latest release.
- Clone the repo:
git clone firstname.lastname@example.org:nicoespeon/gitgraph.js.git.
- Install with npm:
npm install --save gitgraph.js.
- Install with Bower:
bower install gitgraph.js.
- Use the CDNjs hosted lib.
Production files are available under the
Report a bug / Ask for a feature
You found some nasty bug or have a cool feature request? Just open a new issue.
The project uses Grunt with convenient methods for our workflow. It's how we lint our code, run tests, generate documentation, etc. To use it, install the required dependencies as directed and then run the following Grunt commands.
From the command line:
npm install -g grunt-cli.
- Install [the necessary local dependencies] with
npm install. [the necessary local dependencies]: https://github.com/nicoespeon/gitgraph.js/blob/master/package.json
When completed, you'll be able to run the various Grunt commands provided from the command line.
Available Grunt commands
test code -
generate documentation -
Generate source code documentation into
dist/docs/ (not versioned) with
compile a non-versioned release -
dist/ directory, lint code, output the minified release into
dist/gitgraph.min.js and generate the documentation into
compile a new release -
Lint code, output the source and minified releases into
build/ and generate
the official documentation into
open a live reload server -
For a better code experience, this grunt task opens a live server in your favorite browser. This server is automatically reloaded when you save a project file.
Please note that
examples/index.html is the default file for testing ;)
We use SemVer as a guideline for our versioning here.
What does that mean?
Releases will be numbered with the following format:
And constructed with the following guidelines:
- Breaking backward compatibility bumps the
<major>(and resets the
- New additions without breaking backward compatibility bump the
<minor>(and reset the
- Bug fixes and misc. changes bump the
Authors and contributors
Fabien Bernard - @fabien0102
Copyright and License
Copyright (c) 2013 Nicolas CARLO and Fabien BERNARD under the MIT license