Skip to content

Commit 05cc3a5

Browse files
alexweissmanalexweissman
committed
first take
0 parents  commit 05cc3a5

425 files changed

Lines changed: 25899 additions & 0 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.

‎CHANGELOG.md‎

Lines changed: 17 additions & 0 deletions
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‎

Lines changed: 22 additions & 0 deletions
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‎

Lines changed: 59 additions & 0 deletions
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‎

Lines changed: 13 additions & 0 deletions
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: devs@getgrav.org
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‎

Lines changed: 1 addition & 0 deletions
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‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
theme: learn

‎config/plugins/simplesearch.yaml‎

Lines changed: 6 additions & 0 deletions
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‎

Lines changed: 8 additions & 0 deletions
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+

0 commit comments

Comments
 (0)