History

Nabeel Shahzad aa57ab515f Reorganized folders to try to clean up the root folder a bit		2017-12-14 10:38:10 -06:00
..
_includes	Reorganized folders to try to clean up the root folder a bit	2017-12-14 10:38:10 -06:00
_layouts	Reorganized folders to try to clean up the root folder a bit	2017-12-14 10:38:10 -06:00
_sass	Reorganized folders to try to clean up the root folder a bit	2017-12-14 10:38:10 -06:00
css	Reorganized folders to try to clean up the root folder a bit	2017-12-14 10:38:10 -06:00
images	Reorganized folders to try to clean up the root folder a bit	2017-12-14 10:38:10 -06:00
vendor	Reorganized folders to try to clean up the root folder a bit	2017-12-14 10:38:10 -06:00
.gitignore	Reorganized folders to try to clean up the root folder a bit	2017-12-14 10:38:10 -06:00
announcements-4.0.html	Reorganized folders to try to clean up the root folder a bit	2017-12-14 10:38:10 -06:00
browserconfig.xml	Reorganized folders to try to clean up the root folder a bit	2017-12-14 10:38:10 -06:00
community.html	Reorganized folders to try to clean up the root folder a bit	2017-12-14 10:38:10 -06:00
examples.html	Reorganized folders to try to clean up the root folder a bit	2017-12-14 10:38:10 -06:00
index.html	Reorganized folders to try to clean up the root folder a bit	2017-12-14 10:38:10 -06:00
options-old.html	Reorganized folders to try to clean up the root folder a bit	2017-12-14 10:38:10 -06:00
options.html	Reorganized folders to try to clean up the root folder a bit	2017-12-14 10:38:10 -06:00
README.md	Reorganized folders to try to clean up the root folder a bit	2017-12-14 10:38:10 -06:00

README.md

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?

In the main Select2 repository, you can build the documentation by executing

grunt docs

Which will start up the documentation on port 4000. You will need Jekyll installed to build the documentation.