84 lines
No EOL
2.7 KiB
Markdown
84 lines
No EOL
2.7 KiB
Markdown
# Deliver
|
|
Deliver is the [Grav][grav] theme. Simple, fast and modern.
|
|
|
|
## Installation
|
|
To install this template, just download the zip version of this repository and unzip it under `/your/site/grav/user/themes`. Then, rename the folder to `deliver`.
|
|
|
|
You should now have all the theme files under
|
|
|
|
/your/site/grav/user/themes/deliver
|
|
|
|
[grav]: http://github.com/getgrav/grav
|
|
[afterburner2]: http://www.rockettheme.com/joomla-templates/afterburner2
|
|
|
|
## Features
|
|
|
|
* Lightweight and minimal for optimal performance
|
|
* Fully responsive with off-page mobile navigation
|
|
* SCSS based CSS source files for easy customization
|
|
* Built-in support for on-page navigation
|
|
* Mutliple page template types
|
|
* Fontawesome icon support
|
|
|
|
### Supported Page Templates
|
|
|
|
* Default view template
|
|
* Blog view template
|
|
* Error view template
|
|
* Blog item vew template
|
|
* Modular view templates:
|
|
* Features Modular view template
|
|
* Showcase Modular view template
|
|
* Text Modular view template
|
|
* SnipCart view template
|
|
|
|
### Menu Features
|
|
|
|
##### Dropdown Menu
|
|
|
|
You can enable **dropdown menu** support by enabling it in the `deliver.yaml` configuration file. As per usual, copy this file to your `user/config/themes/` folder (create if required) and edit there.
|
|
|
|
```
|
|
dropdown:
|
|
enabled: true
|
|
```
|
|
|
|
This will ensure that sub-pages show up as sub-menus in the navigation.
|
|
|
|
##### Menu Text & Icons
|
|
|
|
Each page shows up in the menu using the title by default, however you can set what displays in the menu directly by setting an explicit `menu:` option in the page header:
|
|
|
|
```
|
|
menu: My Menu
|
|
```
|
|
|
|
You can also provide an icon to show up in front of the menu item by providing an `icon:` option. You need to use name of the FontAwesome icon without the `fa-` prefix. Check out the full [list of current FontAwesome 4.2 icons](http://fortawesome.github.io/Font-Awesome/icons/):
|
|
|
|
```
|
|
icon: bar-chart-o
|
|
```
|
|
|
|
#### Custom Menu Items
|
|
|
|
By default, Grav generates the menu from the page structure. However, there are times when you may want to add custom menu items to the end of the menu. This is now supported in Deliver by creating a menu list in your `site.yaml` file. An example of this is as follows:
|
|
|
|
```
|
|
menu:
|
|
- text: Source
|
|
url: https://github.com/getgrav/grav
|
|
- icon: twitter
|
|
url: http://twitter.com/getgrav
|
|
```
|
|
|
|
The `url:` option is required, but you can provide **either** or **both** `text:` and/or `icon:`
|
|
|
|
### Blog Features
|
|
|
|
##### Daring Fireball Link Pages
|
|
|
|
Deliver supports the ability for a page to have a `link:` header option. This will then in turn create a **link page** where the title of the page will actually be linked to the link provided and a prefexid double angle `>>` will link to the page itself. Simply provide the link in the page header:
|
|
|
|
```
|
|
link: http://getgrav.org/blog
|
|
``` |