Das Git-Plugin fügt Ihren Dokumentationsseiten Repository-basierte Metadaten hinzu. Es zeigt an, wann jede Seite zuletzt geändert wurde, wer beigetragen hat, und bietet optional einen “Diese Seite bearbeiten”-Link - alles direkt aus Ihrem Git-Verlauf ohne Konfiguration.

Funktionen

Zeitstempel der letzten Aktualisierung

Jede Seite zeigt automatisch an, wann sie zuletzt geändert wurde. Der Zeitstempel wird aus dem letzten Git-Commit abgeleitet, der die Quelldatei betrifft.

Zeitstempel verwenden relative Formatierung für aktuelle Änderungen (“vor 2 Std.”, “vor 3 T.”) und wechseln zu absoluten Daten für ältere Inhalte (“15. März 2026”).

Commit-Verlauf-Tooltip

Bewegen Sie den Mauszeiger über den Text “Zuletzt aktualisiert”, um einen Tooltip mit den letzten Commits für diese Seite anzuzeigen. Jeder Eintrag zeigt die Commit-Nachricht, den Autor (mit Gravatar-Avatar) und den relativen Zeitstempel.

Dies bietet schnellen Kontext über aktuelle Änderungen, ohne die Seite zu verlassen - nützlich, um zu verstehen, was aktualisiert wurde und von wem.

Bearbeitungslinks

Bei Konfiguration mit einer Repository-URL zeigt das Plugin einen “Diese Seite bearbeiten”-Link an, der die Quelldatei direkt im Web-Editor Ihres Git-Anbieters öffnet.

plugins: {
  git: {
    repo: 'https://github.com/ihre-org/ihre-docs',
    branch: 'main'
  }
}

Das Plugin erkennt automatisch GitHub-, GitLab- und Bitbucket-URLs und erstellt das korrekte Bearbeitungslink-Format für jeden Anbieter.

Konfiguration

Vollständiges Beispiel

import { defineConfig } from '@docmd/core';

export default defineConfig({
  plugins: {
    git: {
      repo: 'https://github.com/docmd-io/docs',
      branch: 'main',
      editLink: true,
      lastUpdated: true,
      commitHistory: true,
      maxCommits: 5
    }
  }
});

Seitenspezifische Steuerung

Deaktivieren Sie das Git-Plugin für bestimmte Seiten über Frontmatter:

---
title: "Interne Notizen"
plugins:
  git: false
---

Diese Seite zeigt keine Zeitstempel oder Bearbeitungslinks an.

Funktionsweise

Das Plugin liest den Git-Verlauf zur Build-Zeit mit Standard-Git-Befehlen. Für jede Markdown-Datei:

1. Führt git log aus, um den Commit-Verlauf abzurufen
2. Extrahiert Zeitstempel, Autoren und Commit-Nachrichten
3. Fügt die Daten in den Seitenkontext ein
4. Client-seitiges JavaScript rendert die UI-Komponenten

Anforderungen

• Die Dokumentationsquelle muss sich in einem Git-Repository befinden
• Git muss in der Build-Umgebung verfügbar sein
• Dateien müssen mindestens einen Commit in ihrem Verlauf haben

Seiten ohne Git-Verlauf (neue, noch nicht committete Dateien) zeigen keine Zeitstempel oder Commit-Verlauf an.

Migration von editLink

Wenn Sie zuvor die editLink-Konfigurationsoption verwendet haben, bietet das Git-Plugin dieselbe Funktionalität mit zusätzlichen Features:

Vorher (editLink-Konfiguration):

export default defineConfig({
  editLink: {
    enabled: true,
    baseUrl: 'https://github.com/org/repo/edit/main/docs',
    text: 'Diese Seite bearbeiten'
  }
});

Nachher (Git-Plugin):

export default defineConfig({
  plugins: {
    git: {
      repo: 'https://github.com/org/repo',
      branch: 'main'
    }
  }
});

Das Git-Plugin erstellt automatisch die Bearbeitungs-URL aus Repository und Branch, sodass Sie den vollständigen Bearbeitungspfad nicht mehr manuell angeben müssen.

Lokalisierung

Das Plugin enthält Übersetzungen für alle UI-Strings. Unterstützte Sprachen:

• Englisch (en)
• Deutsch (de)
• Chinesisch (zh)

Benutzerdefinierte Übersetzungen können über das Standard-UI-Strings-System bereitgestellt werden.