Skip to main content

Verwalten der Profil-README

Du kannst deinem GitHub-Profil eine README-Datei mit Informationen zu deiner Person hinzufügen.

Informationen zur Profil-README

Du kannst Informationen über dich selbst mit der Community über your GitHub Enterprise Server instance teilen, indem du eine Profil-README-Datei erstellst. GitHub zeigt deine Profil-README oben auf der Profilseite an.

Du entscheidest, welche Informationen in deine Profil-README aufgenommen werden sollen, sodass du die vollständige Kontrolle darüber hast, wie du Dich selbst auf GitHub präsentierst. Hier einige Beispiele für Informationen, die Besucher in deiner Profil-README interessant, unterhaltsam oder nützlich finden können.

  • Ein Abschnitt "Über mich", in dem deine Arbeit und deine Interessen beschrieben werden
  • Beiträge, auf die du stolz bist, sowie der Kontext zu diesen Beiträgen
  • Anleitungen zum Abrufen von Hilfe in Communitys, deren Mitglied du bist

In dem Profil angezeigte Profil-README-Datei

Du kannst mithilfe von GitHub Flavored Markdown Text formatieren und Emojis, Bilder und GIFs in deine Profil-README einfügen. Weitere Informationen findest du unter Erste Schritte beim Schreiben und Formatieren auf GitHub. Eine praktische Anleitung zum Anpassen deiner Profil-README-Datei findest du unter Schnellstart zum Schreiben auf GitHub.

Voraussetzungen

GitHub zeigt deine Profil-README auf deiner Profilseite an, wenn Folgendes zutrifft.

  • Du hast ein Repository mit einem Namen erstellt, der deinem GitHub-Benutzernamen entspricht.
  • Das Repository ist öffentlich.
  • Das Repository enthält eine Datei namens README.md im Stammverzeichnis.
  • Die README.md-Datei enthält beliebige Inhalte.

Hinweis: Wenn du ein öffentliches Repository erstellt hast, dessen Name deinem Benutzernamen vor Juli 2020 entspricht, zeigt GitHub nicht automatisch die README des Repositorys in deinem Profil an. Du kannst die README des Repositorys manuell für dein Profil freigeben, indem du zum Repository auf GitHub.com wechselst und auf Share to profile (Für Profil freigeben) klickst.

Schaltfläche zum Freigeben der README für das Profil

Hinzufügen einer Profil-README

  1. Verwende in der oberen rechten Ecke einer beliebigen Seite das -Dropdownmenü, und wähle Neues Repository aus. Dropdownmenü mit der Option zum Erstellen eines neuen Repositorys

  2. Gibt unter "Repository name" (Repositoryname) einen Repositorynamen ein, der deinem GitHub-Benutzernamen entspricht. Wenn dein Benutzername beispielsweise "octocat" lautet, muss der Repositoryname "octocat" sein. Repositorynamensfeld, das dem Benutzernamen entspricht

  3. Füge optional eine Beschreibung deines Repositorys hinzu. Beispiel: "Mein persönliches Repository". Feld zum Eingeben einer Repository-Beschreibung

  4. Wähle Öffentlich aus. Optionsfelder zum Auswählen der Sichtbarkeit mit öffentlichem ausgewähltem 1. Aktivieren Sie das Kontrollkästchen Initialize this repository with a README (Dieses Repository mit einer README-Datei initialisieren). Dieses Repository mit einer README-Datei initialisieren 1. Klicke auf Repository erstellen. Schaltfläche zum Erstellen eines Repositorys

  5. Klicke oberhalb der rechten Seitenleiste auf Edit README (ReadME bearbeiten). Schaltfläche zum Bearbeiten der README-Datei

    In die generierte README-Datei wird vorab als Inspiration für deine Profil-README eine Vorlage eingegeben. README-Datei mit vorab ausgefüllter Vorlage

Eine Zusammenfassung aller verfügbaren Emojis und ihrer Codes findest Di unter "Emoji-Cheatsheet".

Hinzufügen einer Profil-README

Die Profil-README wird aus deinem GitHub-Profil entfernt, wenn eine der folgenden Aussagen zutrifft:

  • Die README-Datei ist leer oder nicht vorhanden.
  • Das Repository ist privat.
  • Der Repositoryname stimmt nicht mehr mit deinem Benutzernamen überein.

The method you choose is dependant upon your needs, but if you're unsure, we recommend making your repository private. Die Schritte, mit denen du dein Repository privat machen kannst, findest du unter Ändern der Sichtbarkeit eines Repositorys.

Weiterführende Themen