select2/docs

Select2 Documentation

This repository holds the latest documentation for Select2.

What is this?

The documentation is automatically extracted from the docs directory at the Select2 source repository. This is done periodically by the maintainers of Select2.

How can I fix an issue in these docs?

If you are reading this from the source repository, within the docs directory, then you're already in the right place. You can fork the source repository, commit your changes, and then make a pull request and it will be reviewed.

If you are reading this from the documentation repository, you are in the wrong place. Pull requests made directly to the documentation repository will be ignored and eventually closed, so don't do that.

How can I build these docs manually?

Requirements

Ruby and Jekyll

Jekyll is a static site builder written in Ruby. You will need the latest version of Jekyll installed to build the Select2 documentation.

First, make sure that you have a Ruby environment set up. Then, to install Jekyll:

gem install jekyll bundler

To upgrade Jekyll:

gem update jekyll

npm and Grunt

Select2 uses Grunt, which is an npm package, as a task runner. To run the build task, you will need to first install the latest version of npm and Node.js as well as the Grunt CLI.

Building the docs with Grunt

This assumes that you have already cloned the Select2 repo to your local development environment. In the main Select2 repository, you will first need to install the npm dependencies locally:

npm install

Then, you can build and launch the documentation by running

grunt docs

This will start up the documentation on port 4000 (http://localhost:4000).