78 lines
3.1 KiB
Markdown
78 lines
3.1 KiB
Markdown
# Markdown Parser WP - Installationsanleitung und Dokumentation
|
|
|
|
## Übersicht
|
|
|
|
Markdown Parser WP ist ein WordPress-Plugin, das YAML-Metadaten aus Markdown-Dateien extrahiert und in JSON konvertiert, während es gleichzeitig den Markdown-Inhalt ohne die Titelüberschrift bereitstellt. Das Plugin bietet sowohl eine Admin-Oberfläche als auch Shortcode-Funktionalität für die Verwendung in Beiträgen und Seiten.
|
|
|
|
## Installation
|
|
|
|
1. Laden Sie die Zip-Datei `markdown-parser-wp.zip` herunter
|
|
2. Loggen Sie sich in Ihren WordPress-Admin-Bereich ein
|
|
3. Navigieren Sie zu "Plugins" > "Installieren"
|
|
4. Klicken Sie auf "Plugin hochladen"
|
|
5. Wählen Sie die heruntergeladene Zip-Datei aus und klicken Sie auf "Jetzt installieren"
|
|
6. Nach der Installation klicken Sie auf "Plugin aktivieren"
|
|
|
|
## Systemanforderungen
|
|
|
|
- WordPress 5.0 oder höher
|
|
- PHP 7.2 oder höher
|
|
- PHP YAML-Erweiterung (wird automatisch installiert, wenn Composer verfügbar ist)
|
|
|
|
## Verwendung
|
|
|
|
### Admin-Oberfläche
|
|
|
|
1. Nach der Aktivierung finden Sie im WordPress-Admin-Menü einen neuen Eintrag "Markdown Parser"
|
|
2. Klicken Sie auf diesen Menüpunkt, um die Plugin-Oberfläche zu öffnen
|
|
3. Geben Sie die URL zu einer Markdown-Datei mit YAML-Frontmatter ein
|
|
4. Klicken Sie auf "Markdown parsen"
|
|
5. Die extrahierten JSON-Metadaten und der Markdown-Inhalt werden angezeigt
|
|
6. Sie können die Ergebnisse kopieren oder herunterladen
|
|
|
|
### Shortcode-Verwendung
|
|
|
|
Sie können die geparsten Daten direkt in Ihren Beiträgen oder Seiten anzeigen, indem Sie den folgenden Shortcode verwenden:
|
|
|
|
```
|
|
[markdown_parser url="https://example.com/file.md" display="both"]
|
|
```
|
|
|
|
Parameter:
|
|
- `url`: URL zur Markdown-Datei (erforderlich)
|
|
- `display`: Was angezeigt werden soll: "json", "markdown" oder "both" (Standard: "both")
|
|
|
|
## Funktionen
|
|
|
|
- Extrahiert YAML-Metadaten aus Markdown-Dateien und konvertiert sie in JSON
|
|
- Extrahiert den Markdown-Inhalt ohne die Titelüberschrift
|
|
- Bietet eine benutzerfreundliche Admin-Oberfläche
|
|
- Ermöglicht das Kopieren und Herunterladen der Ergebnisse
|
|
- Stellt einen Shortcode für die Anzeige in Beiträgen und Seiten bereit
|
|
- Unterstützt mehrsprachige Übersetzungen
|
|
|
|
## Fehlerbehebung
|
|
|
|
Wenn das Plugin nicht korrekt funktioniert, überprüfen Sie Folgendes:
|
|
|
|
1. Stellen Sie sicher, dass die URL zu einer gültigen Markdown-Datei mit YAML-Frontmatter führt
|
|
2. Überprüfen Sie, ob die YAML-Syntax in der Markdown-Datei korrekt ist
|
|
3. Stellen Sie sicher, dass Ihr Server auf externe URLs zugreifen kann
|
|
|
|
## Entwicklerinformationen
|
|
|
|
Das Plugin verwendet die Symfony YAML-Komponente zum Parsen von YAML-Daten. Wenn Sie das Plugin weiterentwickeln möchten, können Sie die folgenden Dateien bearbeiten:
|
|
|
|
- `markdown-parser-wp.php`: Hauptplugin-Datei
|
|
- `src/MarkdownParser.php`: Kernfunktionalität zum Parsen von Markdown
|
|
- `src/Admin.php`: Admin-AJAX-Funktionalität
|
|
- `src/Shortcodes.php`: Shortcode-Funktionalität
|
|
- `assets/js/admin.js`: JavaScript für die Admin-Oberfläche
|
|
- `assets/css/admin.css`: CSS für die Admin-Oberfläche
|
|
- `assets/css/frontend.css`: CSS für die Frontend-Anzeige
|
|
|
|
|
|
---
|
|
|
|
Dieses Plugin wurde basierend auf dem bereitgestellten PHP-Code erstellt, der die Symfony YAML-Komponente verwendet.
|