getgrav / Grav Skeleton Rtfm Site
Licence: mit
Grav RTFM Skeleton
Stars: ✭ 74
Projects that are alternatives of or similar to Grav Skeleton Rtfm Site
The Documentation Compendium
📢 Various README templates & tips on writing high-quality documentation that people want to read.
Stars: ✭ 4,306 (+5718.92%)
Mutual labels: documentation, documentation-tool
Documentation
📖 documentation for modern JavaScript
Stars: ✭ 5,443 (+7255.41%)
Mutual labels: documentation, documentation-tool
Helm Dash
Browse Dash docsets inside emacs
Stars: ✭ 455 (+514.86%)
Mutual labels: documentation, documentation-tool
Peach
Peach is a web server for multi-language, real-time synchronization and searchable documentation.
Stars: ✭ 1,166 (+1475.68%)
Mutual labels: documentation, documentation-tool
Markdown Guide
The comprehensive Markdown reference guide.
Stars: ✭ 835 (+1028.38%)
Mutual labels: documentation, documentation-tool
Sphinx
Main repository for the Sphinx documentation builder
Stars: ✭ 4,313 (+5728.38%)
Mutual labels: documentation, documentation-tool
Pdoc
🐍 ➡️ 📜 Auto-generate API documentation for Python projects
Stars: ✭ 604 (+716.22%)
Mutual labels: documentation, documentation-tool
Compodoc
📔 The missing documentation tool for your Angular, Nest & Stencil application
Stars: ✭ 3,567 (+4720.27%)
Mutual labels: documentation, documentation-tool
Awesome Magento2
Curated list of awesome Magento 2 Extensions, Resources and other Highlights
Stars: ✭ 817 (+1004.05%)
Mutual labels: documentation, documentation-tool
Standardese
A (work-in-progress) nextgen Doxygen for C++
Stars: ✭ 713 (+863.51%)
Mutual labels: documentation, documentation-tool
Doc2dash
Create docsets for Dash.app-compatible API browser.
Stars: ✭ 380 (+413.51%)
Mutual labels: documentation, documentation-tool
App
Fast and searchable Ruby docs
Stars: ✭ 47 (-36.49%)
Mutual labels: documentation, documentation-tool
Docute
📚 Effortless documentation, done right.
Stars: ✭ 3,575 (+4731.08%)
Mutual labels: documentation, documentation-tool
Awesome Readme
A guide to writing an Awesome README. Read the full article in Towards Data Science.
Stars: ✭ 65 (-12.16%)
Mutual labels: documentation, documentation-tool
Docsify
🃏 A magical documentation site generator.
Stars: ✭ 19,310 (+25994.59%)
Mutual labels: documentation, documentation-tool
Ldoc
LDoc is a LuaDoc-compatible documentation generator which can also process C extension source. Markdown may be optionally used to render comments, as well as integrated readme documentation and pretty-printed example files.
Stars: ✭ 481 (+550%)
Mutual labels: documentation, documentation-tool
Investigate.vim
A Vim plugin for looking up documentation
Stars: ✭ 282 (+281.08%)
Mutual labels: documentation, documentation-tool
Sourcedocs
Generate Markdown documentation from source code
Stars: ✭ 286 (+286.49%)
Mutual labels: documentation, documentation-tool
Devdocs
API Documentation Browser
Stars: ✭ 27,208 (+36667.57%)
Mutual labels: documentation, documentation-tool
Pdoc
API Documentation for Python Projects
Stars: ✭ 853 (+1052.7%)
Mutual labels: documentation, documentation-tool
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:
- Download RTFM Skeleton
- Unzip the package into your web root folder.
- Point your browser at the folder.
- Job done!
TIP: Check out the general Grav Installation Instructions for more details on this process.
Note that the project description data, including the texts, logos, images, and/or trademarks,
for each open source project belongs to its rightful owner.
If you wish to add or remove any projects, please contact us at [email protected].