1
0
mirror of synced 2024-11-22 21:16:10 +03:00
select2/docs
Kevin Brown 9d4ec4f85b Add templating documentation
This adds documentation for the `templateResult` and
`templateSelection` options.  The fact that placeholders and
custom messages are templated was noted, although most people
should be using the standard `text` property that they provide
anyway.  This fixes the templating link provided in the release
announcement to link to the correct location in the documentation.

This also adds support for the `templateSelection` function to
return a DocumentFragment or jQuery compatible object to be
passed back and rendered.

This closes https://github.com/select2/select2/issues/3005.
This closes https://github.com/select2/select2/issues/3019.
2015-02-09 19:27:10 -05:00
..
_includes Changed how the builds are done 2015-01-22 14:49:39 -05:00
_layouts Added Google Analytics 2015-01-05 19:30:15 -05:00
dist Started building the docs site 2014-10-21 21:43:58 -04:00
vendor Added templating example 2015-02-09 17:35:40 -05:00
.gitignore Started building the docs site 2014-10-21 21:43:58 -04:00
announcements-4.0.html Add templating documentation 2015-02-09 19:27:10 -05:00
community.html Called out 3.5.2 dodcs 2015-01-05 18:22:27 -05:00
examples.html Added templating example 2015-02-09 17:35:40 -05:00
index.html Add rel=stylesheet to the cdn link 2015-02-05 17:34:54 +01:00
options.html Add templating documentation 2015-02-09 19:27:10 -05:00
README.md Automatically set up docs symlink 2015-01-12 19:56:25 -05:00

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.