Table of Contents
- Quick start
- What's included
- Supported browsers
- Example as demonstration
- Copyright and license
Several quick start options are available:
npm i jq-timeline
bower install jq-timeline
- Download the latest release.
- Clone the repository:
git clone https://github.com/ka215/jquery.timeline.git
- Load via CDN:
<link href="https://cdn.jsdelivr.net/gh/ka215/jquery.timeline@master/dist/jquery.timeline.min.css" rel="stylesheet"> <script src="https://cdn.jsdelivr.net/gh/ka215/jquery.timeline@master/dist/jquery.timeline.min.js"></script>
Within the download you'll find the following directories and files, logically grouping common assets and providing compiled and minified variations. You'll see something like this:
jquery.timeline/ └── dist/ ├── jquery.timeline.min.css └── jquery.timeline.min.js
We provide compiled and minified CSS and JS (
When deployed by using task for develop, generated source maps (
jquery.timeline.*.map) are available for use with certain browsers' developer tools.
Include the installed files into your html:
<link rel="stylesheet" src="/path/to/jquery.timeline.min.css"> <script src="/path/to/jquery.timeline.min.js"></script>
defer attribute into script tag.
Bind this plugin in the scope had imported the jQuery:
jQuery.Timeline version 2.x supports the following browsers:
The tutorial as a detailed usage of jQuery.Timeline is released here.
jQuery.Timeline's documentation, included in this repository in the root directory, is built with ESDoc and publicly hosted on GitHub Pages at https://ka215.github.io/jquery.timeline/. The docs may also be run locally.
Documentation for previous releases
- For v2.0.x: https://ka2.org/jquery-timeline/
- For v2.0.x(ESDoc): https://ka215.github.io/jquery.timeline/
- For v1.0.x: https://raw.githubusercontent.com/ka215/jquery.timeline/v1/README.md
- For v1.0.x (Japanese): https://ka2.org/jquery-timeline-v1/
Example as demonstration
Your donations for plugin development will help us.
ka2 (Katsuhiko Maeno)
- Guillaume Bonnaire www.gbonnaire.fr