Skip to content

README_DE.md

Latest commit

 

History

History
286 lines (225 loc) · 8.42 KB

README_DE.md

File metadata and controls

286 lines (225 loc) · 8.42 KB

PowerWiki Dokumentation

PowerWiki License Node

Ein modernes Git-basiertes Markdown-Wiki-System mit automatischer Synchronisierung, Syntax-Highlighting und Feishu-UI.

🔗 Live-Demo: https://powerwiki.ga666666.cn

English • 中文 • 日本語 • 한국어 • Español • Français • Deutsch • Русский

Sprachauswahl

Dokumentation in anderen Sprachen：

Funktionen

  • Automatische Synchronisierung - Dokumente automatisch von Git-Repositories abrufen und aktualisieren
  • Syntax-Highlighting - Syntax-Highlighting für mehrere Programmiersprachen
  • Responsives Design - Perfekt an alle Bildschirmgrößen angepasst
  • Automatisches Inhaltsverzeichnis - Inhaltsverzeichnis automatisch generieren
  • Moderne UI - Sauberes und intuitives Interface-Design
  • PDF-Unterstützung - PDF-Dateien in hoher Auflösung rendern
  • Besucherstatistiken - Automatische Statistik der Artikelaufrufe
  • Leichtgewichtig - Keine Datenbank erforderlich
  • SEO Optimiert - Suchmaschinensichtbarkeit vollständig optimiert
  • Frontmatter-Unterstützung - YAML-Metadaten parsen
  • Lokale Bilder - Unterstützung für lokale Bilder in Markdown
  • Mehrsprachig - Unterstützung für Deutsch und Englisch
  • Docker-Unterstützung - Vollständige Docker-Deployment-Unterstützung

Schnellstart

Voraussetzungen

  • Node.js >= 14.0.0
  • Git

Docker verwenden (Empfohlen)

# Repository klonen
git clone https://github.com/steven-ld/PowerWiki.git
cd PowerWiki

# Konfigurationsdatei erstellen
cp config.example.json config.json
# config.json mit Ihrer Git-Repository-URL bearbeiten

# Mit Docker Compose starten
docker-compose up -d

Node.js verwenden

# Repository klonen
git clone https://github.com/steven-ld/PowerWiki.git
cd PowerWiki

# Abhängigkeiten installieren
npm install

# Konfigurationsdatei erstellen
cp config.example.json config.json
# config.json mit Ihrer Git-Repository-URL bearbeiten

# Server starten
npm start

Besuchen Sie http://localhost:3150 in Ihrem Browser.

Konfiguration

config.json bearbeiten：

{
  "gitRepo": "https://github.com/your-username/your-wiki-repo.git",
  "repoBranch": "main",
  "port": 3150,
  "siteTitle": "My Wiki",
  "siteDescription": "Knowledge Base",
  "autoSyncInterval": 180000,
  "pages": {
    "home": "README.md",
    "about": "ABOUT.md"
  }
}
Option Beschreibung Standard
gitRepo Git-Repository-URL -
repoBranch Branch-Name main
mdPath Markdown-Dateien Unterverzeichnis ""
port Server-Port 3150
siteTitle Seitentitel PowerWiki
siteDescription Seitenbeschreibung Wiki
autoSyncInterval Auto-Sync-Intervall (ms) 180000
sortOrder Sortierreihenfolge (modified oder name) modified
pages.home Startseitendatei ""
pages.about Über-Seitendatei ""

Docker-Deployment

Docker-Image

@sayunchuan stellt ein Docker-Image für PowerWiki bereit.

Schnellstart

# Einfachste Methode
docker run -d -p 3150:3150 sayunchuan/powerwiki

# Mit benutzerdefinierter Konfiguration
docker run -d \
  --name powerwiki \
  -p 3150:3150 \
  -v $(pwd)/config.json:/app/config.json:ro \
  -v powerwiki_data:/app/data \
  -v powerwiki_cache:/app/cache \
  sayunchuan/powerwiki

Deployment mit Docker Compose

version: '3.8'
services:
  powerwiki:
    image: sayunchuan/powerwiki:latest
    ports:
      - "3150:3150"
    environment:
      - NODE_ENV=production
      - LANG=de
    volumes:
      - ./config.json:/app/config.json:ro
      - powerwiki_data:/app/data
      - powerwiki_cache:/app/cache
    restart: unless-stopped

volumes:
  powerwiki_data:
  powerwiki_cache:
# Dienste starten
docker-compose up -d

# Logs anzeigen
docker-compose logs -f

# Dienste stoppen
docker-compose down

Danksagung: Vielen Dank an @sayunchuan für die Bereitstellung des Docker-Images, wodurch die Bereitstellung von PowerWiki bequemer wird.

Artikelorganisation

PowerWiki unterstützt eine hierarchische Ordnerstruktur zur Organisation von Artikeln：

your-wiki-repo/
├── README.md              # Startseite
├── ABOUT.md               # Über-Seite
├── images/                # Globale Bilder (optional)
├── Architecture/          # Kategorieordner
│   ├── images/            # Kategoriebilder
│   ├── IoT-Device-Standards.md
│   ├── TLS-Encryption.md
│   └── README.md          # Kategorieindex
└── Projects/              # Eine weitere Kategorie
    ├── images/
    ├── URL-Shortener.md
    └── README.md

Artikel-Frontmatter

Jeder Artikel kann YAML-Frontmatter-Metadaten enthalten：

---
title: Artikeltitel
description: Artikelbeschreibung für SEO
author: Autorenname
date: 2026-01-10
updated: 2026-01-10
keywords: schlagwort1, schlagwort2, schlagwort3
tags: [tag1, tag2]
---

Technologie-Stack

  • Backend: Express.js
  • Frontend: Vanilla JavaScript
  • Git: simple-git
  • Markdown: marked + highlight.js
  • PDF: pdfjs-dist
  • Containerisierung: Docker

Projektstruktur

PowerWiki/
├── src/                     # Quellcode
│   ├── index.js             # Einstiegspunkt des Express-Servers
│   ├── routes/              # Routen-Module
│   │   ├── api.js           # API-Routen
│   │   ├── feeds.js         # RSS/Sitemap-Routen
│   │   └── static.js        # Statische Datei-Routen
│   ├── config/              # Konfigurations-Module
│   │   ├── env.js           # Umgebungsvariablen
│   │   └── i18n.js          # Internationalisierung
│   └── utils/               # Hilfsmodule
│       ├── cacheManager.js  # Cache-Verwaltung
│       ├── gitManager.js    # Git-Operationen
│       └── markdownParser.js# Markdown-Parser
├── locales/                 # Übersetzungsdateien
├── templates/               # HTML-Vorlagen
├── public/                  # Statische Assets
│   ├── index.html          # Frontend HTML
│   ├── app.js             # Haupteinstieg (modular)
│   ├── js/                # JavaScript-Module
│   │   ├── theme.js       # Theme-Verwaltung
│   │   ├── i18n.js        # Internationalisierung
│   │   ├── cache.js       # Client-Caching
│   │   ├── utils.js       # Hilfsfunktionen
│   │   ├── posts.js       # Beitragsliste & Baum
│   │   ├── article.js     # Artikel-Rendering
│   │   ├── toc.js         # Inhaltsverzeichnis
│   │   └── media.js       # Code-Kopieren, Bilder, PDF
│   └── css/               # CSS-Module
│       ├── base.css       # Basis-Stile & Variablen
│       ├── layout.css     # Layout
│       ├── sidebar.css    # Navigationsmenü
│       ├── article.css    # Artikel & Markdown
│       ├── toc.css        # Rechtes Inhaltsverzeichnis
│       ├── media.css      # Responsive Design
│       └── components.css # UI-Komponenten
├── config.example.json      # Konfigurationsvorlage
└── package.json             # Abhängigkeiten

Lizenz

MIT License - see LICENSE für Details.

Mitwirkende

  • @sayunchuan - Mehrsprachige Unterstützung, Mermaid-Unterstützung hinzugefügt, verschiedene Probleme behoben

Wenn dieses Projekt hilft, bitte ⭐ Stern geben!