1
0
mirror of synced 2024-11-25 22:36:03 +03:00
select2/docs
Kevin Brown 74387b9863 Switched examples to use Jekyll's highlighting
This fixes some bugs that were present in the old Prettify highlighter
when there was a mix of JavaScript and HTML in the same code block. Now
with Rouge, the highlighter used by Jekyll, these cases are properly
handled and HTML no longer looks strange.

This does not convert all of the code blocks over, because there are
still some code blocks which double as the actual JavaScript code
powering the example that need to be migrated.
2016-01-30 18:09:01 -05:00
..
_includes Switched examples to use Jekyll's highlighting 2016-01-30 18:09:01 -05:00
_layouts Update AnchorJS from v0.3.1 to 1.1.1. 2015-06-11 03:45:31 +02:00
_sass Replace tabs with spaces for consistency 2015-06-18 10:19:56 +02:00
css Tidy and simplify CSS; add very basic documentation. 2015-06-08 01:46:53 +02:00
dist Started building the docs site 2014-10-21 21:43:58 -04:00
images Add logo to .navbar-brand. 2015-04-28 02:08:06 +02:00
vendor Update AnchorJS from v0.3.1 to 1.1.1. 2015-06-11 03:45:31 +02:00
.gitignore Started building the docs site 2014-10-21 21:43:58 -04:00
announcements-4.0.html fix: modify announcement 4.0 doc Tags example 2015-08-03 11:48:26 +01:00
community.html Fix layout. 2015-06-07 01:03:37 +02:00
examples.html Fixed responsive example in documentation 2016-01-03 18:57:49 -05:00
index.html Switched index to use Jekyll's code highlighting 2016-01-28 11:54:24 -05:00
options-old.html Migrate old options to options-old 2015-09-14 19:24:46 -04:00
options.html Rename options-new to options 2015-09-14 19:30:32 -04:00
README.md Clarified the documentation README [ci skip] 2015-02-24 17:27:16 -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.

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.