1
0
mirror of synced 2024-11-22 13:06:08 +03:00
select2/docs/README.md
Kevin Brown 766d9f05e0 Automatically set up docs symlink
This also adds some docs about building the documentation.
[ci skip]
2015-01-12 19:56:25 -05:00

1002 B

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.

Pull requests will usually be ignored, documentation fixes should be made in the source repository. We may accept pull requests if they match the source docs directory, but for the most part pull requests will be closed on sight.

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.