mkdocs glightbox
mkdocs-glightbox-0.4.0
Ein MkDocs-Plugin unterstützt Bild-Lightbox mit GLightbox.
GLightbox ist eine reine Javascript-Lightbox-Bibliothek mit mobiler Unterstützung.
Live-Demo mit Material für MkDocs.
Installieren Sie das Plugin von PyPI
pip install mkdocs-glightbox Fügen Sie glightbox -Plugin zu Ihren mkdocs.yml-Plugin-Abschnitten hinzu:
plugins :
- glightboxAlle Bilder werden automatisch zum Lightbox-Effekt hinzugefügt, mit Ausnahme von Bildern in einem Ankertag und Emoji-Bildern aus Pymdown-Erweiterungen.
Sie können das Plugin anpassen, indem Sie Optionen in mkdocs.yml übergeben:
plugins :
- glightbox :
touchNavigation : true
loop : false
effect : zoom
slide_effect : slide
width : 100%
height : auto
zoomable : true
draggable : true
skip_classes :
- custom-skip-class-name
auto_caption : false
caption_position : bottom
background : white
shadow : true
manual : false| Option | Standard | Beschreibung |
|---|---|---|
| touchNavigation | WAHR | Aktivieren oder deaktivieren Sie die Touch-Navigation (Wischen). |
| Schleife | FALSCH | Schlaufenrutschen am Ende. |
| Wirkung | Zoom | Name des Effekts beim Öffnen der Lightbox. (Zoom, Ausblenden, keine) |
| slide_effect | gleiten | Name des Effekts auf der Lightbox-Folie. (gleiten, zoomen, ausblenden, keine) |
| Breite | Auto | Breite für Inline-Elemente und Iframes. Sie können jede Einheit verwenden, zum Beispiel 90 % oder 100 VW für die volle Breite. |
| Höhe | Auto | Höhe für Inline-Elemente und Iframes. Sie können jede Einheit verwenden, zum Beispiel 90 %, 100 Vh oder Auto. |
| zoombar | WAHR | Zoombare Bilder aktivieren oder deaktivieren. |
| ziehbar | WAHR | Aktivieren oder deaktivieren Sie das Ziehen mit der Maus, um zur vorherigen und nächsten Folie zu wechseln. |
| überspringen_klassen | [ ] | Deaktivieren Sie die Lightbox dieser Bilder mit einem bestimmten benutzerdefinierten Klassennamen. |
| auto_caption | FALSCH | Aktivieren oder deaktivieren Sie die automatische Verwendung des Alt-Bilds als Untertiteltitel. |
| caption_position | unten | Standardposition für Untertitel. (unten, oben, links, rechts) |
| Hintergrund | Weiß | Das Hintergrund-CSS des Lightbox-Bildes. Der Hintergrund wird angezeigt, wenn das Bild transparent ist. Sie können einen beliebigen CSS-Wert für den Hintergrund verwenden, zum Beispiel #74b9ff oder Gainsboro , oder umsonst none . |
| Schatten | WAHR | Aktivieren oder deaktivieren Sie den Schatten des Lightbox-Bildes. Deaktivieren Sie es, wenn der Hintergrund none ist, um Schatten um das transparente Bild herum zu vermeiden. |
| Handbuch | FALSCH | Wenn „true“, muss Lightbox für jedes Bild manuell aktiviert werden, indem man ihm die Klasse on-glb oder glightbox: true “ auf der Seite hinzufügt. |
Weitere Informationen zu Optionen finden Sie in GLightbox Docs.
Für mehr Flexibilität:
Unterstützen Sie die Lightbox-Bildunterschrift. Weitere Details finden Sie unter „Untertitel“.
Unterstützen Sie das Gruppieren von Bildern als Galerien. Weitere Details finden Sie in der Galerie.
Notiz
Wenn Sie die MkDocs-Plugin-Funktion zum ersten Mal verwenden, sollten Sie wissen, dass MkDocs ein Standard-Plugin namens search enthält. Wenn Sie die Suchfunktion beibehalten möchten, müssen Sie das search Plugin wieder zur plugins -Liste hinzufügen.
site/assets/javascripts/ und die CSS-Datei in das Verzeichnis site/assets/stylesheets/Dieses Projekt ist unter der MIT-Lizenz lizenziert – Einzelheiten finden Sie in der Datei LICENSE.md.
