-
Notifications
You must be signed in to change notification settings - Fork 97
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
34 changed files
with
1,379 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
git: | ||
problems: | ||
url: https://github.com/getgrav/grav-plugin-problems | ||
path: user/plugins/problems | ||
branch: develop | ||
error: | ||
url: https://github.com/getgrav/grav-plugin-error | ||
path: user/plugins/error | ||
branch: develop | ||
breadcrumbs: | ||
url: https://github.com/getgrav/grav-plugin-breadcrumbs | ||
path: user/plugins/breadcrumbs | ||
branch: develop | ||
anchors: | ||
url: https://github.com/getgrav/grav-plugin-anchors | ||
path: user/plugins/anchors | ||
branch: develop | ||
highlight: | ||
url: https://github.com/getgrav/grav-plugin-highlight | ||
path: user/plugins/highlight | ||
branch: develop | ||
simplesearch: | ||
url: https://github.com/getgrav/grav-plugin-simplesearch | ||
path: user/plugins/simplesearch | ||
branch: develop | ||
learn2: | ||
url: https://github.com/getgrav/grav-theme-learn2 | ||
path: user/themes/learn2 | ||
branch: develop | ||
links: | ||
problems: | ||
src: grav-plugin-problems | ||
path: user/plugins/problems | ||
scm: github | ||
error: | ||
src: grav-plugin-error | ||
path: user/plugins/error | ||
scm: github | ||
breadcrumbs: | ||
src: grav-plugin-breadcrumbs | ||
path: user/plugins/breadcrumbs | ||
scm: github | ||
anchors: | ||
src: grav-plugin-anchors | ||
path: user/plugins/anchors | ||
scm: github | ||
highlight: | ||
src: grav-plugin-highlight | ||
path: user/plugins/highlight | ||
scm: github | ||
simplesearch: | ||
src: grav-plugin-simplesearch | ||
path: user/plugins/simplesearch | ||
scm: github | ||
learn2: | ||
src: grav-theme-learn2 | ||
path: user/themes/learn2 | ||
scm: github |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# v1.0.0 | ||
## 06/17/2015 | ||
|
||
1. [](#new) | ||
* ChangeLog started... |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,46 @@ | ||
# grav-skeleton-rtfm-site | ||
# RTFM Skeleton | ||
|
||
![RTFM Screenshot](assets/rtfm-screenshot.png) | ||
|
||
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) | ||
|
||
# Features | ||
|
||
* Lightweight and minimal for optimal performance | ||
* Fully responsive with off-page mobile navigation | ||
* SCSS based CSS source files for easy customization | ||
* Built specifically for providing easy to read documentation | ||
* Fontawesome icon support | ||
|
||
# Supported Page Templates | ||
|
||
* "Docs" template | ||
* "Chapter" template | ||
* Error view template | ||
|
||
# Configuration | ||
|
||
``` | ||
top_level_version: false | ||
home_url: | ||
github: | ||
enabled: true | ||
position: top | ||
tree: https://github.com/getgrav/grav-skeleton-rtfm-site/blob/develop/ | ||
commits: https://github.com/getgrav/grav-skeleton-rtfm-site/commits/develop/ | ||
``` | ||
|
||
## Basic Setup for a New Grav Site | ||
|
||
The simplest way to install the learn2 theme with RTFM content for Grav is to download and install the RTFM Skeleton package: | ||
|
||
1. [Download RTFM Skeleton](http://getgrav.org/downloads/skeletons#extras) | ||
2. Unzip the package into your web root folder. | ||
3. Point your browser at the folder. | ||
4. Job done! | ||
|
||
**TIP:** Check out the [general Grav Installation Instructions](http://learn.getgrav.org/basics/installation) for more details on this process. | ||
|
||
--- | ||
|
||
|
Empty file.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
name: RTFM Site | ||
version: 1.0.0 | ||
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" | ||
icon: book | ||
author: | ||
name: Team Grav | ||
email: [email protected] | ||
url: http://getgrav.org | ||
homepage: https://github.com/getgrav/grav-skeleton-rtfm-site | ||
demo: http://demo.getgrav.org/rtfm-skeleton | ||
keywords: rtfm, skeleton, documentation, docs | ||
bugs: https://github.com/getgrav/grav-skeleton-rtfm-site/issues | ||
license: MIT |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
selectors: '#body h2, #body h3, #body h4, #body h5' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
theme: learn |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
enabled: true | ||
built_in_css: false | ||
route: /search | ||
template: simplesearch_results | ||
filters: | ||
category: docs |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
title: RTFM Documentation | ||
metadata: | ||
description: 'RTFM Skeleton' | ||
|
||
taxonomies: [category,tag] | ||
summary: | ||
size: 300 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
home: | ||
alias: '/basics' | ||
|
||
pages: | ||
theme: learn2 | ||
markdown_extra: true | ||
process: | ||
markdown: true | ||
twig: false | ||
|
||
cache: | ||
enabled: true | ||
check: | ||
method: file | ||
driver: auto | ||
prefix: 'g' | ||
|
||
twig: | ||
cache: true | ||
debug: false | ||
auto_reload: true | ||
autoescape: false | ||
|
||
assets: | ||
css_pipeline: true | ||
css_minify: true | ||
css_rewrite: true | ||
js_pipeline: true | ||
js_minify: true | ||
|
||
debugger: | ||
enabled: false | ||
twig: true | ||
shutdown: | ||
close_connection: true |
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
assets: | ||
css_pipeline: false | ||
js_pipeline: false | ||
|
||
twig: | ||
cache: true | ||
debug: true | ||
|
||
debugger: | ||
enabled: false |
Oops, something went wrong.