README.md aktualisiert

2026-03-18 21:02:53 +00:00
parent ee592829c0
commit 2326e6a3fd
1 changed files with 120 additions and 1 deletions
--- a/README.md
+++ b/README.md
@@ -1,2 +1,121 @@
-# WP-Multi-Wiki
+# 📚 WP Multi Wiki

+**WP Multi Wiki** ist ein WordPress-Plugin zum Erstellen und Verwalten mehrerer Wikis auf einer Website — ideal für Plugin-Dokumentationen, Wissensdatenbanken und Support-Seiten.
+
+![Version](https://img.shields.io/badge/Version-1.0.0-blue)
+![WordPress](https://img.shields.io/badge/WordPress-5.8%2B-21759b)
+![PHP](https://img.shields.io/badge/PHP-7.4%2B-777bb4)
+![Lizenz](https://img.shields.io/badge/Lizenz-GPL%20v2-green)
+
+---
+
+## ✨ Features
+
+- **Mehrere Wikis** — Erstelle beliebig viele voneinander unabhängige Wikis
+- **Kategorien & Tags** — Artikel nach Themen strukturieren
+- **Automatisches Inhaltsverzeichnis** — wird aus den Überschriften generiert
+- **AJAX-Suche** — schnelle Live-Suche innerhalb eines Wikis
+- **Breadcrumb-Navigation** — immer wissen wo man ist
+- **Sidebar-Navigation** — übersichtliche Artikelliste pro Wiki
+- **Verwandte Artikel** — ähnliche Artikel am Ende anzeigen
+- **Prev/Next Navigation** — zwischen Artikeln blättern
+- **Gitea Wiki Importer** — Wikis direkt aus einer Gitea-Instanz importieren
+- **Shortcodes** — Wikis überall auf der Seite einbetten
+- **Theme-Adaptiv** — passt sich automatisch an Dark & Light Mode an
+
+---
+
+## 📦 Installation
+
+1. Repository als ZIP herunterladen
+2. In WordPress: **Plugins → Installieren → Plugin hochladen**
+3. ZIP auswählen und installieren
+4. Plugin aktivieren
+5. Im Admin-Menü erscheint **WP Multi Wiki**
+
+---
+
+## 🚀 Schnellstart
+
+### 1. Wiki erstellen
+**WP Multi Wiki → Neues Wiki** → Titel, Icon, Farbe und Version eingeben → **Wiki erstellen**
+
+### 2. Artikel hinzufügen
+**WP Multi Wiki → Neuer Artikel** → Titel, Inhalt, Wiki zuordnen → **Artikel erstellen**
+
+### 3. Wiki auf einer Seite einbinden
+Shortcode auf einer beliebigen WordPress-Seite einfügen:
+
+```
+[wmw_wiki id="1"]
+```
+
+---
+
+## 📋 Shortcodes
+
+| Shortcode | Beschreibung |
+|-----------|-------------|
+| `[wmw_wiki_list]` | Alle Wikis als Karten-Übersicht |
+| `[wmw_wiki id="1"]` | Ein Wiki mit allen Artikeln |
+| `[wmw_wiki slug="mein-plugin"]` | Wiki per Slug einbinden |
+| `[wmw_search wiki_id="1"]` | Suchfeld für ein bestimmtes Wiki |
+| `[wmw_article id="5"]` | Einzelnen Artikel einbetten |
+| `[wmw_breadcrumb]` | Breadcrumb-Navigation |
+
+---
+
+## ⚙️ Einstellungen
+
+Unter **WP Multi Wiki → Einstellungen** konfigurierbar:
+
+| Einstellung | Standard | Beschreibung |
+|-------------|----------|-------------|
+| Inhaltsverzeichnis | ✅ an | Automatisch aus Überschriften generiert |
+| Breadcrumbs | ✅ an | Navigation Home → Wiki → Artikel |
+| Verwandte Artikel | ✅ an | Ähnliche Artikel am Ende |
+| Suchfeld | ✅ an | AJAX-Suche im Wiki |
+| Sidebar-Position | Links | Links, Rechts oder keine Sidebar |
+| Artikel pro Seite | 20 | Anzahl der Artikel in Listen |
+| Custom CSS | — | Eigenes CSS für das Frontend |
+
+---
+
+## 🐙 Gitea Wiki Importer
+
+Wikis direkt aus einer Gitea-Instanz importieren:
+
+1. **WP Multi Wiki → Gitea Import** öffnen
+2. Gitea-Server URL, Owner und Repository eintragen
+3. Auf **Seiten vorab laden** klicken — Vorschau aller verfügbaren Seiten
+4. Ziel-Wiki auswählen
+5. Seiten die übersprungen werden sollen eintragen (z.B. `Home`, `_Sidebar`)
+6. **Wiki jetzt importieren** klicken
+
+**Folgende Markdown-Elemente werden automatisch konvertiert:**
+Überschriften, Fett/Kursiv, Code-Blöcke, Tabellen, Links, Bilder, Blockquotes, Listen und Gitea-interne `[[Wiki-Links]]`
+
+> Für **private Repositories** einen Access Token unter Gitea → Einstellungen → Anwendungen erstellen (Scope: `read:wiki`) und im Importer eintragen.
+
+---
+
+## 🔧 Voraussetzungen
+
+- WordPress **5.8** oder höher
+- PHP **7.4** oder höher
+- MySQL **5.6** / MariaDB **10.1** oder höher
+
+---
+
+## 👤 Autor
+
+**M_Viper**
+- Website: [M-Viper.de](https://M-Viper.de)
+- Gitea: [git.viper.ipv64.net](https://git.viper.ipv64.net/M_Viper)
+
+---
+
+## 📄 Lizenz
+
+Dieses Plugin ist unter der **GNU General Public License v2 or later** lizenziert.
+Weitere Informationen: [http://www.gnu.org/licenses/gpl-2.0.html](http://www.gnu.org/licenses/gpl-2.0.html)