Florian Kissling eef50c9b94 Add .s2-docs-home to "home" layout, add partial for homepage CSS. 10 jaren geleden
..
_includes e0e79dbc4e Make "Topics" menu item .active when "announcements-4.0" is the current page. 10 jaren geleden
_layouts eef50c9b94 Add .s2-docs-home to "home" layout, add partial for homepage CSS. 10 jaren geleden
_sass eef50c9b94 Add .s2-docs-home to "home" layout, add partial for homepage CSS. 10 jaren geleden
css f73dc290fd Move most of the default CSS to partials/Sass. 10 jaren geleden
dist 4ae3439dbc Started building the docs site 10 jaren geleden
vendor d98cbcec21 Add a fixed sidebar with anchor navigation to the sidebar. 10 jaren geleden
.gitignore 4ae3439dbc Started building the docs site 10 jaren geleden
README.md 5b95c0e834 Clarified the documentation README [ci skip] 10 jaren geleden
announcements-4.0.html 33b637dbf9 Ditch wrong .lead copy. 10 jaren geleden
community.html 7b62c7d444 Remove icon. 10 jaren geleden
examples.html 0474e69e6e Add .s2-docs-container to enable anchor.js. 10 jaren geleden
index.html 25ba1ef1f3 Prettify <pre> on homepage. 10 jaren geleden
options.html 80dbd692db Don't show line numbers for one line code examples. 10 jaren geleden

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.