Diese Version von GitHub Enterprise wird eingestellt am 2021-09-23. Es wird keine Patch-Freigabe vorgenommen, auch nicht für kritische Sicherheitsprobleme. Für eine bessere Leistung, verbesserte Sicherheit und neue Features nimm ein Upgrade auf die neueste Version von GitHub Enterprise vor. Wende Dich an den GitHub Enterprise-Support, um Hilfe beim Upgrade zu erhalten.

Informationen zu README-Dateien

Du kannst eine README-Datei zu Deinem Repository hinzufügen, um anderen Personen mitzuteilen, warum Dein Projekt nützlich ist, was sie mit Deinem Projekt machen können und wie sie es nutzen können.

Informationen zu README-Dateien

You can add a README file to a repository to communicate important information about your project. A README, along with a repository license and contribution guidelines, communicates expectations for your project and helps you manage contributions.

For more information about providing guidelines for your project, see "Setting up your project for healthy contributions."

Die README-Datei ist oft das erste Element, das ein Benutzer beim Besuch Deines Repositorys sieht. README-Dateien enthalten in der Regel folgende Informationen:

  • Was ist die Aufgabe des Projekts?
  • Warum ist das Projekt sinnvoll?
  • Wie können Benutzer am Projekt mitwirken?
  • Wo erhalten Benutzer Hilfe zu Ihrem Projekt?
  • Wer verwaltet das Projekt und trägt dazu bei?

Wenn Sie Ihre README-Datei im Stammverzeichnis, im Ordner docs oder im verborgenen Verzeichnis .github Ihres Repositorys ablegen, erkennt GitHub Enterprise Server Ihre README-Datei und stellt sie automatisch den Besuchern des Repositorys zur Verfügung.

Hauptseite des github/scientist-Repositorys und seiner README-Datei

If you add a README file to the root of a public repository with the same name as your username, that README will automatically appear on your profile page. You can edit your profile README with GitHub Flavored Markdown to create a personalized section on your profile. For more information, see "Managing your profile README."

README file on your username/username repository

Auto-generated table of contents for README files

For the rendered view of any Markdown file in a repository, including README files, GitHub Enterprise Server will automatically generate a table of contents based on section headings. You can view the table of contents for a README file by clicking the menu icon at the top left of the rendered page.

README with automatically generated TOC

The auto-generated table of contents is enabled by default for all Markdown files in a repository, but you can disable this feature for your repository.

  1. Navigiere in GitHub Enterprise Server zur Hauptseite des Repository.
  2. Klicke unter Deinem Repository-Namen auf Settings (Einstellungen). Schaltfläche „Repository settings" (Repository-Einstellungen)
  3. Under "Features", deselect Table of contents. Automatic TOC setting for repositories

Du kannst direkt zu einem Abschnitt in einer gerenderten Datei verweisen, indem Du den Mauszeiger über den Abschnittstitel bewegst, um den Link sichtbar zu machen:

Abschnittslink innerhalb der README-Datei für das github/scientist-Repository

Du kannst relative Links und Bildpfade in Deinen gerenderten Dateien definieren, um Leser dabei zu unterstützen, in Deinem Repository zu anderen Dateien zu navigieren.

Ein relativer Link ist ein Verknüpfung, die relativ zur aktuellen Datei ist. Wenn Du beispielsweise eine README-Datei im Stammverzeichnis (root) Deines Repositorys und eine andere Datei in docs/CONTRIBUTING.md hast, könnte der relative Link zu CONTRIBUTING.md in Deiner README-Datei wie folgt aussehen:

[Beitragsrichtlinien für dieses Projekt](docs/CONTRIBUTING.md)

GitHub Enterprise Server wandelt Ihren relativen Link oder den Bildpfad automatisch anhand dessen um, auf welchem Branch Sie sich gerade befinden, damit der Link oder der Pfad immer funktioniert. Du kannst alle relativen Link-Operanden verwenden, beispielsweise ./ und ../.

Relative Links sind für Benutzer, die Dein Repository klonen, einfacher zu verwenden. Absolute Links funktionieren möglicherweise nicht in Klons Deines Repositorys - wir empfehlen relative Links zu verwenden, um auf andere Dateien in Deinem Repository zu verweisen.

Weiterführende Informationen

Did this doc help you?Privacy policy

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

Oder, learn how to contribute.