Skip to content

Commit 67328e3

Browse files
committed
Replace docs with a redirect
1 parent 0bbf614 commit 67328e3

254 files changed

Lines changed: 17 additions & 17543 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/.gitignore

Lines changed: 0 additions & 2 deletions
This file was deleted.

docs/README.md

Lines changed: 5 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -1,67 +1,12 @@
11
Select2 Documentation
22
=====================
3-
[This repository][select2-docs-source] holds the latest documentation for
3+
[This repository][select2-docs-source] holds a redirect to the latest documentation for
44
[Select2][select2].
55

6-
What is this?
7-
-------------
8-
The documentation is automatically extracted from the `docs` directory at the
9-
[Select2 source repository][select2-source]. This is done periodically by
10-
the maintainers of Select2.
11-
12-
How can I fix an issue in these docs?
6+
How can I fix an issue in the docs?
137
-------------------------------------
14-
If you are reading this from the source repository, within the `docs` directory,
15-
then you're already in the right place. You can fork the source repository,
16-
commit your changes, and then make a pull request and it will be reviewed.
17-
18-
**If you are reading this from the
19-
[documentation repository][select2-docs-source], you are in the wrong place.**
20-
Pull requests made directly to the documentation repository will be ignored and
21-
eventually closed, so don't do that.
22-
23-
How can I build these docs manually?
24-
------------------------------------
25-
26-
### Requirements
27-
28-
##### Ruby and Jekyll
29-
30-
Jekyll is a static site builder written in Ruby. You will need **the latest version** of [Jekyll][jekyll] installed to build the Select2 documentation.
31-
32-
First, [make sure that you have a Ruby environment set up][jekyll-quickstart]. Then, to install Jekyll:
33-
34-
`gem install jekyll bundler`
35-
36-
To upgrade Jekyll:
37-
38-
`gem update jekyll`
39-
40-
##### npm and Grunt
41-
42-
Select2 uses [Grunt][grunt], which is an npm package, as a task runner. To run the build task, you will need to first [install the latest version of npm and Node.js][nodejs] as well as the [Grunt CLI][grunt-cli].
43-
44-
### Building the docs with Grunt
45-
46-
This assumes that you have already cloned the Select2 repo to your local development environment. In the [main Select2 repository][select2-source], you will first need to install the npm dependencies locally:
47-
48-
```
49-
npm install
50-
```
51-
52-
Then, you can build and launch the documentation by running
53-
54-
```bash
55-
grunt docs
56-
```
57-
58-
This will start up the documentation on port 4000 ([http://localhost:4000](http://localhost:4000)).
8+
Submit a pull request at [select2-new-docs][the new documentation repository].
599

60-
[jekyll]: http://jekyllrb.com/
61-
[jekyll-quickstart]: https://jekyllrb.com/docs/quickstart/
62-
[grunt]: https://gruntjs.com
63-
[grunt-cli]: https://gruntjs.com/getting-started
64-
[nodejs]: https://nodejs.org/en/download/
65-
[select2]: https://select2.github.io
10+
[select2]: https://select2.org
6611
[select2-docs-source]: https://github.com/select2/select2.github.io
67-
[select2-source]: https://github.com/select2/select2
12+
[select2-new-docs]: https://github.com/select2/docs

docs/_includes/examples/basics.html

Lines changed: 0 additions & 97 deletions
This file was deleted.

docs/_includes/examples/data.html

Lines changed: 0 additions & 123 deletions
This file was deleted.

docs/_includes/examples/disabled-mode.html

Lines changed: 0 additions & 43 deletions
This file was deleted.

docs/_includes/examples/disabled-results.html

Lines changed: 0 additions & 29 deletions
This file was deleted.

docs/_includes/examples/hide-search.html

Lines changed: 0 additions & 22 deletions
This file was deleted.

0 commit comments

Comments
 (0)