Mitwirken an der GitHub-Dokumentation

Erfahren Sie, wie das GitHub Docs Team Dokumentation erstellt und wie Sie mitwirken können.

Übersicht Schnellstart

Empfohlen

Informationen zur Mitwirkung an der GitHub-Dokumentation

Du kannst auf verschiedene Weise zu Inhalten der GitHub-Dokumentation beitragen.

Bewährte Methoden für GitHub-Dokumente

Orientieren Sie sich an diesen bewährten Methoden, um Dokumente zu erstellen, die benutzerfreundlich und leicht verständlich sind.

Stil-Leitfaden

Befolgen Sie diesen Leitfaden, um sicherzustellen, dass GitHubdie Dokumentation konsistent bleibt und klare Muster befolgt, die unsere Leser verstehen können.

Artikel

Write and format content

Ändern eines Artikeltitels

Wenn der Titel eines Artikels geändert werden muss, muss der Name möglicherweise an mehreren Stellen aktualisiert werden.
Write and format content

Anmerkungen zu Codebeispielen

Du kannst Codebeispiele mit Anmerkungen versehen, um zu erläutern, wie sie funktionieren und wie sie für andere Zwecke angepasst werden können.
Get set up to contribute

Arbeiten an GitHub-Dokumentationen in einem Codespace

Sie können GitHub Codespaces verwenden, um an der Dokumentation für GitHub Docs zu arbeiten.
Write and format content

Auffindbar machen von Inhalten in der Suche

Halten Sie sich an diese bewährten SEO-Methoden, damit Benutzer die Dokumentation zu GitHub mithilfe von Suchmaschinen einfacher finden können.
Understand the GitHub approach to docs

Bewährte Methoden für GitHub-Dokumente

Orientieren Sie sich an diesen bewährten Methoden, um Dokumente zu erstellen, die benutzerfreundlich und leicht verständlich sind.
Write and format content

Dokumentation zur Versionierung

GitHub Docs verwendet YAML-Frontmatter und Liquid-Operatoren, um mehrere Versionen von GitHub mit einem Single-Source-Ansatz zu unterstützen.
Get set up to contribute

Erstellen einer lokalen Umgebung

Sie können die GitHub Docs Anwendung lokal auf Ihrem Computer ausführen.
Write and format content

Erstellen von Diagrammen für GitHub Docs

In diesem Handbuch wird erläutert, wann und wie Diagramme erstellt GitHub Docswerden.
Write and format content

Erstellen von Screenshots

Sie können Benutzern helfen, Elemente der Benutzeroberfläche zu finden, die schwer zu finden sind, indem Sie Screenshots hinzufügen GitHub Docs.
Anzeigen 1 bis 9 von 37