|
1 | | -# RTFM Skeleton |
| 1 | +# select2.org |
2 | 2 |
|
3 | | - |
| 3 | +https://select2.org |
4 | 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) |
| 5 | +This is the repository for the documentation for Select2. It is built with the flat-file CMS [Grav](http://getgrav.org), using their [RTFM skeleton](https://github.com/getgrav/grav-skeleton-rtfm-site#rtfm-skeleton). |
6 | 6 |
|
7 | | -# Features |
| 7 | +## Local installation |
8 | 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 |
| 9 | +### Step 1 - Install Grav |
16 | 10 |
|
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*. |
| 11 | +This application uses the [Grav](https://learn.getgrav.org/) CMS. This repository does not contain a full Grav installation - rather, it just contains the contents of Grav's `user` directory, which is where all of our content, themes, and assets live. This was done as per the [recommendation on Grav's blog](https://getgrav.org/blog/developing-with-github-part-2), to make it easier to deploy changes to the live server. |
18 | 12 |
|
19 | | -# Supported Page Templates |
| 13 | +To install this website on your computer, first [install grav core](https://getgrav.org/downloads) in a project folder called `select2-docs` under your webserver's document root folder. Then, find the `user` folder inside of your project folder. Delete the contents of the `user` folder and clone this repository directly into the user folder. |
20 | 14 |
|
21 | | -* "Docs" template |
22 | | -* "Chapter" template |
23 | | -* Error view template |
24 | | - |
25 | | -# Configuration |
| 15 | +When you're done it might look something like this: |
26 | 16 |
|
27 | 17 | ``` |
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/ |
| 18 | +htdocs/ |
| 19 | +└── select2-docs/ |
| 20 | + ├── assets/ |
| 21 | + ├── ... |
| 22 | + ├── user/ |
| 23 | + ├── .git |
| 24 | + ├── accounts/ |
| 25 | + ├── assets/ |
| 26 | + ├── config/ |
| 27 | + └── ... |
| 28 | + └── ... |
| 29 | +
|
35 | 30 | ``` |
36 | 31 |
|
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. | |
| 32 | +### Step 2 |
| 33 | + |
| 34 | +Grav needs your webserver to be able to write to certain directories. In OSX with XAMPP installed, this won't work by default. To deal with this: |
45 | 35 |
|
46 | | -## Basic Setup for a New Grav Site |
| 36 | +Add default webserver user `daemon` to OSX's `staff` group (which already has the necessary permissions for writing to files/directories): |
47 | 37 |
|
48 | | -The simplest way to install the learn2 theme with RTFM content for Grav is to download and install the RTFM Skeleton package: |
| 38 | +`sudo dseditgroup -o edit -a daemon -t user staff` |
49 | 39 |
|
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! |
| 40 | +### Step 3 |
54 | 41 |
|
55 | | -**TIP:** Check out the [general Grav Installation Instructions](http://learn.getgrav.org/basics/installation) for more details on this process. |
| 42 | +Visit the local installation in your browser! For example, http://localhost/select2-docs. |
56 | 43 |
|
57 | | ---- |
| 44 | +## Credits |
58 | 45 |
|
| 46 | +Favicons were generated with https://realfavicongenerator.net/ |
59 | 47 |
|
0 commit comments