getherbie/plugin-gist

Gist Plugin for Herbie.

Installs: 221

Dependents: 1

Suggesters: 0

Stars: 1

Watchers: 0

Forks: 0

Open Issues: 0

Type:herbie-plugin

v1.0.0 2016-04-05 15:01 UTC

README

Gist ist ein Herbie Plugin, mit dem du Gist-Schnipsel von Github in deine Website einbettest.

Installation

Das Plugin installierst du via Composer.

$ composer require getherbie/plugin-gist

Danach aktivierst du das Plugin in der Konfigurationsdatei.

plugins:
    enable:
        - gist

Konfiguration

Unter plugins.config.gist stehen dir die folgenden Optionen zur Verfügung:

# enable shortcode
shortcode: true

# enable twig function
twig: false

Anwendung

Mit dem Gist-Shortcode kannst du in Seiteninhalten jedes beliebige Gist-Schnipsel einbinden, wobei "123456789" die ID des gewünschten Gist ist.

[gist 123456789]

oder

[gist id="123456789"]    

Möchtest du eine bestimmte Datei innerhalb eines Gist anzeigen, kannst Du dies mit dem optionalen file-Parameter machen:

[gist id="12345" file="filename.md"]

Mit dem Aktivieren der Twig-Funktion kannst du Gist-Schnipsel auch in Layoutdateien einsetzen:

{{ gist id="123456789" }}    

{{ gist id="12345" file="filename.md" }}

Parameter

Name Beschreibung Typ Default
id Die Gist-ID string empty
file Eine bestimmte Datei innerhalb des Gist string empty

Demo

https://www.getherbie.org/dokumentation/plugins/gist