GitHub Integration

Verbinden Sie Ihre Dockit-Dokumentationsseite mit GitHub, um kollaborative Bearbeitungs- und Versionskontrollfunktionen zu ermöglichen.

Quick Setup

1. Repository-Verbindung: Verknüpfen Sie Ihr Dokumentations-Repository, um GitHub-Funktionen zu aktivieren
2. Authentifizierung: Richten Sie die GitHub-Authentifizierung für Mitwirkende ein
3. Zweigverwaltung: Konfigurieren Sie, welche Zweige für die Dokumentation verwendet werden sollen

Features

Edit on GitHub

Aktivieren Sie die Links „Diese Seite bearbeiten“, die Benutzer dazu leiten, die Dokumentation direkt auf GitHub zu bearbeiten.

Version Control

Verfolgen Sie Änderungen an Ihrer Dokumentation mit vollständigem Git-Verlauf und Commit-Tracking.

Collaborative Editing

Allow team members to contribute to documentation through GitHub pull requests.

Automatic Deployments

Richten Sie automatische Bereitstellungen ein, wenn Änderungen an Ihren Hauptzweig übertragen werden.

Configuration

Basic Setup

{
  "github": {
    "repository": "your-username/your-docs-repo",
    "branch": "main",
    "editLinks": true
  }
}

Authentication

Konfigurieren Sie die GitHub-Authentifizierung in Ihren Site-Einstellungen:

// Example GitHub auth configuration
const githubConfig = {
  clientId: "your-github-app-id",
  redirectUri: "https://your-docs-site.com/auth/callback"
};

Usage Examples

Edit Links

Auf jeder Seite wird ein Link „Auf GitHub bearbeiten“ angezeigt, der die entsprechende Datei im GitHub-Editor öffnet.

Pull Request Workflow

1. Contributors click “Edit on GitHub”
2. Make changes in GitHub’s web editor
3. Submit pull request
4. Überprüfen und führen Sie Änderungen zusammen
5. Site automatically redeploys

Best Practices

• Halten Sie Ihr Repository für Open-Source-Dokumentation öffentlich
• Verwenden Sie klare Commit-Nachrichten für Dokumentationsänderungen
• Richten Sie Zweigschutzregeln für die Qualitätskontrolle ein
• Aktivieren Sie GitHub Pages für automatisches Hosting

Troubleshooting

Common Issues

Edit links not working: Check repository URL configuration Authentication errors: Verify GitHub app credentials Deployment failures: Review GitHub Actions logs

Ausführlichere Konfigurationsoptionen finden Sie in der GitHub-Integrationsdokumentation.