Skip to content
Build script and documents for the OpenSeadragon site
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.
built-openseadragon/openseadragon Version 2.4.1 Jul 3, 2019
css Additional multi-image information Apr 29, 2015
doctemplates/openseadragon Add favicon. Fix #16 Apr 20, 2016
images Actually add the logo. Apr 20, 2016
releases Add README documenting that releases directory is obsolete Jul 22, 2013
.editorconfig requested corrections; should incl editorconfig file Dec 8, 2017
.gitignore Now building to a local folder first Mar 18, 2013
Gruntfile.js Merge pull request #171 from Daniel-KM/feature/zoomify Jul 14, 2017 Removed jsdoc2 remnants Nov 18, 2013
bower.json Version 2.4.1 Jul 3, 2019
doc-conf.json Doc Template Update Dec 2, 2013 Fix URL to the three.js docs Apr 10, 2018
package-lock.json Upgraded our "marked" dependency Jan 5, 2018
package.json Upgraded our "marked" dependency Jan 5, 2018
site-build.sublime-project Excluding sublime text docs from sublime text project Feb 14, 2013

OpenSeadragon Site-Build

This project compiles static web pages which provide the examples and documentation for using OpenSeadragon.

On the Web

First Time Setup

All command-line operations are scripted using Grunt which is based on Node.js. To get set up:

  1. Install Node, if you haven't already (available at the link above)
  2. Install the Grunt command line runner (if you haven't already); on the command line, run npm install -g grunt-cli
  3. Clone the site-build repository
  4. On the command line, go in to the site-build folder
  5. Run npm install

You're set... continue reading for build and test instructions.

Building the Web Pages

To build, just run (on the command line, in the site-build folder):

grunt build

The built website will appear in site-build/build.

If you want to try the site out in your browser, you can run:

grunt connect watch

This will run a server at http://localhost:9000/.

Building the Docs

grunt doc

... will build the docs into the local build folder.


To publish, run:

grunt publish

This cleans out the folder (which you've cloned from the repository, and resides next to your site-build folder) and builds and copies the web pages and docs into it.

Note that while the OpenSeadragon website resides at, for historical reasons the repository is named

Example Images

If you want to see the website with the appropriate example images, clone the example-images repository into site-build/build and check out its gh-pages branch.

You can’t perform that action at this time.