Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/dev' into dev
Browse files Browse the repository at this point in the history
# Conflicts:
#	README.md
  • Loading branch information
Awilum committed May 4, 2020
1 parent 03ae456 commit d44ea04
Showing 1 changed file with 9 additions and 17 deletions.
26 changes: 9 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<h1 align="center">Site Plugin for <a href="http://flextype.org/">Flextype</a></h1>

<p align="center">
<a href="https://github.com/flextype-plugins/site/releases"><img alt="Version" src="https://img.shields.io/github/release/flextype-plugins/site.svg?label=version&color=black"></a> <a href="https://github.com/flextype-plugins/site"><img src="https://img.shields.io/badge/license-MIT-blue.svg?color=black" alt="License"></a> <a href="https://github.com/flextype-plugins/site"><img src="https://img.shields.io/github/downloads/flextype-plugins/site/total.svg?color=black" alt="Total downloads"></a> <a href="https://github.com/flextype-plugins/site"><img src="https://img.shields.io/badge/Flextype-0.9.8-green.svg?color=black" alt="Flextype"></a> <a href=""><img src="https://img.shields.io/discord/423097982498635778.svg?logo=discord&color=black&label=Discord%20Chat" alt="Discord"></a>
<a href="https://github.com/flextype-plugins/site/releases"><img alt="Version" src="https://img.shields.io/github/release/flextype-plugins/site.svg?label=version&color=black"></a> <a href="https://github.com/flextype-plugins/site"><img src="https://img.shields.io/badge/license-MIT-blue.svg?color=black" alt="License"></a> <a href="https://github.com/flextype-plugins/site"><img src="https://img.shields.io/github/downloads/flextype-plugins/site/total.svg?color=black" alt="Total downloads"></a> <a href="https://github.com/flextype/flextype"><img src="https://img.shields.io/badge/Flextype-0.9.8-green.svg" alt="Flextype"></a> <a href=""><img src="https://img.shields.io/discord/423097982498635778.svg?logo=discord&color=black&label=Discord%20Chat" alt="Discord"></a>
</p>

Site plugin to display entries content on the website frontend.
Expand All @@ -14,23 +14,15 @@ The following dependencies need to be downloaded and installed for Site Plugin.

| Item | Version | Download |
|---|---|---|
| [flextype](https://github.com/flextype/flextype) | 0.9.8 | [download](https://github.com/flextype/flextype/releases/download/v0.9.8/flextype-0.9.8.zip) |

### Plugins
| Item | Version | Download |
|---|---|---|
| [twig](https://github.com/flextype-plugins/twig) | 1.0.0 | [download](https://github.com/flextype-plugins/twig/releases/download/v1.0.0/twig-1.0.0.zip) |

### Themes
| Item | Version | Download |
|---|---|---|
| [noir](https://github.com/flextype-plugins/noir) | 1.0.0 | [download](https://github.com/flextype-plugins/noir/releases/download/v1.0.0/noir-1.0.0.zip) |
| [flextype](https://github.com/flextype/flextype) | 0.9.8 | [download](https://github.com/flextype/flextype/releases) |
| [twig](https://github.com/flextype-plugins/twig) | >=1.0.0 | [download](https://github.com/flextype-plugins/twig/releases) |
| [noir](https://github.com/flextype-plugins/noir) | >=1.0.0 | [download](https://github.com/flextype-plugins/noir/releases) |

## Installation

1. Download & Install all required dependencies.
2. Create new folder `/project/plugins/site`
3. Download Site Plugin and unzip plugin content to the folder `/project/plugins/site`
3. Download jQuery Plugin and unzip plugin content to the folder `/project/plugins/site`

## Documentation

Expand Down Expand Up @@ -79,13 +71,13 @@ bugs: https://github.com/flextype-themes/noir/issues
license: MIT
```
You can reach any of these items via `registry.themes` by using the standard dot-syntax:
You can reach any of these items via registry `themes` by using the standard dot-syntax:

Usage:

```twig
Theme name: {{ registry.themes.noir.manifest.name }}
Theme version: {{ registry.themes.noir.manifest.version }}
Theme name: {{ registry.get('themes.noir.manifest.name') }}
Theme version: {{ registry.get('themes.noir.manifest.version') }}
```

Result:
Expand Down Expand Up @@ -123,7 +115,7 @@ enabled: true
highlight: red
```

Then in your theme templates you can access these variable using the `registry.themes.noir` object:
Then in your theme templates you can access these variable using the `themes.noir` object:

```twig
<h1 style="color:{{ registry.get('themes.noir.settings.highlight') }}">
Expand Down

0 comments on commit d44ea04

Please sign in to comment.