Skip to content
This repository was archived by the owner on Sep 12, 2019. It is now read-only.

Commit 05cc3a5

Browse files
alexweissmanalexweissman
committed
first take
0 parents  commit 05cc3a5

File tree

425 files changed

+25899
-0
lines changed

Some content is hidden

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

425 files changed

+25899
-0
lines changed

‎CHANGELOG.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# v1.0.2
2+
## 06/22/2015
3+
4+
1. [](#new)
5+
* Added sub-topic pages
6+
7+
# v1.0.1
8+
## 06/17/2015
9+
10+
1. [](#new)
11+
* Added screenshot
12+
13+
# v1.0.0
14+
## 06/17/2015
15+
16+
1. [](#new)
17+
* ChangeLog started...

‎LICENSE

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2015 Grav
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.
22+

‎README.md

+59
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# RTFM Skeleton
2+
3+
![RTFM Screenshot](assets/rtfm-screenshot.png)
4+
5+
This is a sample skeleton site that mimics the official Grav documentation: http://learn.getgrav.org. This skeleton uses the [learn2 theme](https://github.com/getgrav/grav-theme-learn2)
6+
7+
# Features
8+
9+
* Lightweight and minimal for optimal performance
10+
* Fully responsive with off-page mobile navigation
11+
* SCSS based CSS source files for easy customization
12+
* Built specifically for providing easy to read documentation
13+
* [Font Awesome](http://fontawesome.io/) icon support
14+
* Viewed page tracking
15+
* Integrated support for documentation content sourced/maintained via GitHub
16+
17+
>> If you want more information about using Grav with GitHub, check out [part 1](http://getgrav.org/blog/developing-with-github-part-1) and [part 2](http://getgrav.org/blog/developing-with-github-part-2) of our guide called *Grav Development with Github*.
18+
19+
# Supported Page Templates
20+
21+
* "Docs" template
22+
* "Chapter" template
23+
* Error view template
24+
25+
# Configuration
26+
27+
```
28+
top_level_version: false
29+
home_url:
30+
github:
31+
enabled: true
32+
position: top
33+
tree: https://github.com/getgrav/grav-skeleton-rtfm-site/blob/develop/
34+
commits: https://github.com/getgrav/grav-skeleton-rtfm-site/commits/develop/
35+
```
36+
37+
| Setting | Child Setting | Description |
38+
| :----- | :----- | :----- |
39+
| top_level_version | | When set to `true`, displays level icons and numbered lists. |
40+
| home_url | | Enables you to enter a different URL link from the logo (ex: http://google.com) |
41+
| github | enabled | Can be set to `true` or `false`. When set to `true`, it generates the **Edit this page** link to GitHub for each page. |
42+
| github | position | Sets the position for the GitHub edit link. Can be set to `top` or `bottom`. |
43+
| github | tree | Sets the tree by which your site's content is based. Generally the repo your site's content is pulled from. |
44+
| github | commits | Sets the link to the commits page for the site's content repo. |
45+
46+
## Basic Setup for a New Grav Site
47+
48+
The simplest way to install the learn2 theme with RTFM content for Grav is to download and install the RTFM Skeleton package:
49+
50+
1. [Download RTFM Skeleton](http://getgrav.org/downloads/skeletons#extras)
51+
2. Unzip the package into your web root folder.
52+
3. Point your browser at the folder.
53+
4. Job done!
54+
55+
**TIP:** Check out the [general Grav Installation Instructions](http://learn.getgrav.org/basics/installation) for more details on this process.
56+
57+
---
58+
59+

‎accounts/.gitkeep

Whitespace-only changes.

‎assets/rtfm-screenshot.png

131 KB
Loading

‎blueprints.yaml

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
name: RTFM Site
2+
version: 1.0.2
3+
description: "RTFM is a sample documentation site using the `learn2` theme. This skeleton is used as the basis for the Grav official documentation: http://learn.getgrav.org"
4+
icon: book
5+
author:
6+
name: Team Grav
7+
email: [email protected]
8+
url: http://getgrav.org
9+
homepage: https://github.com/getgrav/grav-skeleton-rtfm-site
10+
demo: http://demo.getgrav.org/rtfm-skeleton
11+
keywords: rtfm, skeleton, documentation, docs
12+
bugs: https://github.com/getgrav/grav-skeleton-rtfm-site/issues
13+
license: MIT

‎config/plugins/anchors.yaml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
selectors: '#body h2, #body h3, #body h4, #body h5'

‎config/plugins/highlight.yaml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
theme: learn

‎config/plugins/simplesearch.yaml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
enabled: true
2+
built_in_css: false
3+
route: /search
4+
template: simplesearch_results
5+
filters:
6+
category: docs

‎config/site.yaml

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
title: Select2 - The jQuery replacement for select boxes
2+
metadata:
3+
description: Select2 is a jQuery based replacement for select boxes. It supports searching, remote data sets, and pagination (infinite scrolling) of results.
4+
5+
taxonomies: [category,tag]
6+
summary:
7+
size: 300
8+

‎config/system.yaml

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
home:
2+
alias: '/getting-started'
3+
4+
pages:
5+
theme: site
6+
markdown_extra: true
7+
process:
8+
markdown: true
9+
twig: false
10+
11+
cache:
12+
enabled: true
13+
check:
14+
method: file
15+
driver: auto
16+
prefix: 'g'
17+
18+
twig:
19+
cache: true
20+
debug: false
21+
auto_reload: true
22+
autoescape: false
23+
24+
assets:
25+
css_pipeline: true
26+
css_minify: true
27+
css_rewrite: true
28+
js_pipeline: true
29+
js_minify: true
30+
31+
debugger:
32+
enabled: false
33+
twig: true
34+
shutdown:
35+
close_connection: true

‎data/.gitkeep

Whitespace-only changes.

‎localhost/config/security.yaml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
salt: dc7HfDXRG0WT48

‎localhost/config/system.yaml

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
assets:
2+
css_pipeline: false
3+
js_pipeline: false
4+
5+
twig:
6+
cache: true
7+
debug: true
8+
9+
debugger:
10+
enabled: false

‎pages/01.getting-started/01.installation/docs.md

+67
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
---
2+
title: Installation
3+
taxonomy:
4+
category: docs
5+
---
6+
7+
In order to use Select2, you must include the JavaScript and CSS file on
8+
your website. You can get these files built for you from many different
9+
locations.
10+
11+
## Using Select2 from a CDN
12+
13+
Select2 is hosted on both the
14+
<a href="https://cdnjs.com/libraries/select2">cdnjs</a> and
15+
<a href="https://www.jsdelivr.com/#!select2">jsDelivr</a> CDNs, allowing
16+
you to quickly include Select2 on your website.
17+
18+
### Include the assets
19+
20+
Include the following lines of code in the <code>&lt;head&gt;</code>
21+
section of your HTML.
22+
23+
```
24+
<link href="https://cdnjs.cloudflare.com/ajax/libs/select2/4.0.3/css/select2.min.css" rel="stylesheet" />
25+
<script src="https://cdnjs.cloudflare.com/ajax/libs/select2/4.0.3/js/select2.min.js"></script>
26+
```
27+
28+
>>> <i class="fa fa-info-circle"></i> Immediately following a new release, it takes some time for CDNs to
29+
catch up and get the new versions live on the CDN.
30+
31+
### Initialize Select2
32+
33+
Initialize Select2 on the <code>&lt;select&gt;</code> element that you want to make awesome.
34+
35+
```
36+
<script type="text/javascript">
37+
$('select').select2();
38+
</script>
39+
```
40+
41+
### Read the docs
42+
43+
Check out the <a href="/examples">examples chapter</a> to start using the additional features of Select2.
44+
45+
## Downloading the code locally
46+
47+
In some situations, you can't use Select2 from a CDN and you must include the files through your own static file servers.
48+
49+
### Download the code
50+
51+
<a href="https://github.com/select2/select2/tags">
52+
Download the code
53+
</a>
54+
from GitHub and copy the `dist` directory to your project.
55+
56+
### Include the assets
57+
58+
Include the following lines of code in the `<head>` section of your HTML.
59+
60+
```
61+
<link href="path/to/select2.min.css" rel="stylesheet" />
62+
<script src="path/to/select2.min.js"></script>
63+
```
64+
65+
### Read the docs
66+
67+
Check out the <a href="/examples">examples chapter</a> to start using the additional features of Select2.

‎pages/01.getting-started/02.basic-usage/docs.md

+95
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
---
2+
title: Basic Usage
3+
taxonomy:
4+
category: docs
5+
process:
6+
twig: true
7+
never_cache_twig: true
8+
---
9+
10+
## Single select boxes
11+
12+
Select2 was designed to be a replacement for the standard `<select>` box that is displayed by the browser. By default it supports all options and operations that are available in a standard select box, but with added flexibility.
13+
14+
Select2 can take a regular select box like this...
15+
16+
<select class="js-states form-control"></select>
17+
18+
and turn it into this...
19+
20+
<div class="s2-example">
21+
<select class="js-example-basic-single js-states form-control"></select>
22+
</div>
23+
24+
```
25+
<select class="js-example-basic-single">
26+
<option value="AL">Alabama</option>
27+
...
28+
<option value="WY">Wyoming</option>
29+
</select>
30+
```
31+
32+
<script type="text/javascript" class="js-code-example-basic-single">
33+
$(document).ready(function() {
34+
$(".js-example-basic-single").select2();
35+
});
36+
</script>
37+
38+
Select2 will register itself as a jQuery function if you use any of the distribution builds, so you can call `.select2()` on any jQuery selector where you would like to initialize Select2.
39+
40+
```
41+
$('.js-example-basic-single').select2();
42+
```
43+
44+
## Multi-select boxes (pillbox)
45+
46+
Select2 also supports multi-value select boxes. The select below is declared with the `multiple` attribute.
47+
48+
<div class="s2-example">
49+
<p>
50+
<select class="js-example-basic-multiple js-states form-control" multiple="multiple"></select>
51+
</p>
52+
</div>
53+
54+
```
55+
<script type="text/javascript">
56+
$(".js-example-basic-multiple").select2();
57+
</script>
58+
59+
<select class="js-example-basic-multiple" multiple="multiple">
60+
<option value="AL">Alabama</option>
61+
...
62+
<option value="WY">Wyoming</option>
63+
</select>
64+
```
65+
66+
<script type="text/javascript">
67+
$.fn.select2.amd.require([
68+
"select2/core",
69+
"select2/utils"
70+
], function (Select2, Utils, oldMatcher) {
71+
var $basicSingle = $(".js-example-basic-single");
72+
var $basicMultiple = $(".js-example-basic-multiple");
73+
74+
$.fn.select2.defaults.set("width", "100%");
75+
76+
$basicSingle.select2();
77+
$basicMultiple.select2();
78+
79+
function formatState (state) {
80+
if (!state.id) {
81+
return state.text;
82+
}
83+
var $state = $(
84+
'<span>' +
85+
'<img src="vendor/images/flags/' +
86+
state.element.value.toLowerCase() +
87+
'.png" class="img-flag" /> ' +
88+
state.text +
89+
'</span>'
90+
);
91+
return $state;
92+
};
93+
});
94+
95+
</script>

0 commit comments

Comments
 (0)