Leaflet/download.md

58 lines
2.3 KiB
Markdown
Raw Normal View History

2012-07-17 01:21:00 +08:00
---
layout: default
title: Download
---
2012-07-24 06:41:55 +08:00
## Download Leaflet
2012-07-17 01:21:00 +08:00
2012-07-25 21:24:11 +08:00
Besides the library itself, the download package contains full source code, unit tests, files for debugging and a build system. The production files are in the `dist` folder.
<table>
<tr>
<th>Version</th>
<th>Description</th>
</tr>
<tr>
<td class="width100"><a href="https://github.com/CloudMade/Leaflet/zipball/v0.3.1">Leaflet 0.3.1</a></td>
<td>Stable version, released on February 14, 2012</td>
</tr>
<tr>
<td><a href="http://github.com/CloudMade/Leaflet/zipball/master">Leaflet master</a></td>
<td>In-progress version, developed on the <code>master</code> branch</td>
</tr>
</table>
2012-07-17 01:21:00 +08:00
[View Changelog](https://github.com/CloudMade/Leaflet/blob/master/CHANGELOG.md)
2012-07-25 21:24:11 +08:00
Note that the master version can contain incompatible changes, so please read the changelog carefully when upgrading to it.
2012-07-18 21:41:48 +08:00
### Using a Hosted Version of Leaflet
2012-07-17 01:21:00 +08:00
The latest stable release of Leaflet is hosted on a CDN — to start using
it straight away, place this code in the `head` section of your HTML:
<link rel="stylesheet" href="http://cdn.leafletjs.com/leaflet-0.3.1/leaflet.css" />
<!--[if lte IE 8]>
<link rel="stylesheet" href="http://cdn.leafletjs.com/leaflet-0.3.1/leaflet.ie.css" />
<![endif]-->
<script src="http://cdn.leafletjs.com/leaflet-0.3.1/leaflet.js"></script>
2012-07-25 18:15:33 +08:00
### Building Leaflet from the Source
Leaflet build system is powered by the [Node.js](http://nodejs.org) platform and Jake, JSHint and UglifyJS libraries, which install easily and work well across all major platforms. Here are the steps to install it:
1. [Download and install Node](http://nodejs.org)
2. Run the following commands in the command line:
2012-07-26 17:16:38 +08:00
<pre><code class="no-highlight">npm install -g jake
2012-07-25 18:15:33 +08:00
npm install jshint
npm install uglify-js
</code></pre>
Now that you have everything installed, run `jake` inside the Leaflet directory. This will check Leaflet source files for JavaScript errors and inconsistencies, and then combine and compress it to the `dist` folder.
2012-07-18 21:41:48 +08:00
### Building a Custom Version of Leaflet
2012-07-17 01:21:00 +08:00
2012-07-25 18:15:33 +08:00
To make a custom build of the library with only the things you need, open `build/build.html` page of the package contents, choose the components (it figures out dependencies for you) and then run the command generated with it.