getgrav / grav-skeleton-rtfm-site

Grav RTFM Skeleton

RTFM Skeleton

This is a sample skeleton site that mimics the official Grav documentation: http://learn.getgrav.org. This skeleton uses the learn2 theme

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
• Font Awesome icon support
• Viewed page tracking
• Integrated support for documentation content sourced/maintained via GitHub

If you want more information about using Grav with GitHub, check out part 1 and part 2 of our guide called Grav Development with Github.

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/

Setting	Child Setting	Description
top_level_version		When set to true, displays level icons and numbered lists.
home_url		Enables you to enter a different URL link from the logo (ex: http://google.com)
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.
github	position	Sets the position for the GitHub edit link. Can be set to top or bottom.
github	tree	Sets the tree by which your site's content is based. Generally the repo your site's content is pulled from.
github	commits	Sets the link to the commits page for the site's content repo.

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
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 for more details on this process.

---

grav-skeleton-rtfm-site's Issues

Search broken

Searching from the left sidebar from the RTFM skeleton (downloaded from: https://getgrav.org/downloads/skeletons) doesn't work.

Repro:
1 perform a clean install of the skeleton on the server;
2 enter some text in the search box on the left sidebar, and hit Enter;
3 the contents on the page never change (to show the expected search results).

Display all pages in menu?

if it possible to enable the whole menu (all links to be displayed) to show rather then have it hidden.

Error when compiling SCSS

There seems to be a problem in:

error theme/_typography.scss (Line 72: Invalid US-ASCII character "\xEF")

Every time I try to compile the SCSS, because I made some changes, I get this error.

RTFM & Accessibility Guidelines

Any ideas how RTFM meets the Web Content Accessibility Guidelines?
We need to meet these standards if we are to use GRAV/RTFM for our service documentation.
Many thanks in advance...

edit this page link

What needs to be done to get the "edit this page" link to work? I read what I could find here, I searched and no luck. I would like to either make it work or remove it.

theme_config.github.enabled isn't used

Setting theme_config.github.enabled to false doesn't do anything. It's probably meant to be used in /templates/partials/base.html.twig.

Adding a Logo

I am new to Grav and am just starting to learn front-end development. I am thinking of adding a logo file into my custom theme through the pages media. That way the user can change it through the admin panel. I don't know the twig code to access this file. Say I put the image in /_logo -> modular/item how would I go about accessing it from modular, listing and default page types?

Dynamic control of published/unpublished pages

I have added the following variable to site.yaml:
cc_billing: true

and the following to system.yaml:

pages:
theme: maas-docs
markdown_extra: true
process:
markdown: true
twig: true
frontmatter:
process_twig: true

Plus the following to the frontmatter of docs.md:

published: {{ site.cc_billing }}

This is not working and does not give me dynamic control of publishing/unpublishing pages.

Is this possible to achieve?

Edit this page

What needs to be done to get the "edit this page" link to work? I read what I could find here, I searched and no luck. I would like to either make it work or remove it.

CSS not displaying properly on IE11

I unfortunately need to support Grav in a corporate environment using IE11 as the default browser. Sites using the rtfm skeleton do not display properly on IE, no matter what the compatibility settings are. It displays just fine on FireFox and Chrome.

The admin panel displays just fine in IE11. Is it difficult to get this team to display in IE?

How to change logo?

I can change colors etc. but I can't find how to change the logo. Is it referenced in a twig file?

Escape curly braces in twig

I have an issue with using twig site variables from site.yaml

Any pages which contain curly braces in code blocks are giving a server error. How can I escape curly braces when using twig with Grav?