Freigeben über


Metadaten für Microsoft Learn-Dokumentation

Metadaten können im Artikel (im YAML-Front-Matter-Block) oder global in der Datei docfx.json des Repositorys angewendet werden. Wenn Sie einen vorhandenen Artikel bearbeiten, müssen Sie wahrscheinlich keine Metadaten ändern. Wenn Sie jedoch einen neuen Artikel hinzufügen, sind bestimmte Metadaten-Attribute erforderlich, die Sie in den YAML-Front-Matter-Block der Datei einfügen müssen.

Hier sehen Sie ein Beispiel für Metadaten, die im YAML-Front-Matter eines Markdownartikels angewendet werden:

---
title:                     # the article title to show on the browser tab
description:               # 115 - 145 character description to show in search results
author: {github-id}        # the author's GitHub ID - will be auto-populated if set in settings.json
ms.author: {ms-alias}      # the author's Microsoft alias (if applicable) - will be auto-populated if set in settings.json
ms.date: {@date}           # the date - will be auto-populated when template is first applied
ms.topic: getting-started  # the type of article
---
# Heading 1 <!-- the article title to show on the web page -->

Erforderliche Metadaten

In der folgenden Tabelle werden die erforderlichen Metadaten-Attribute aufgeführt. Wenn Sie einen dieser Schlüssel weglassen, tritt während des Builds wahrscheinlich ein Validierungsfehler auf.

Feld Wert Warum?
author Die GitHub-Konto-ID des Autors Der Autor kann anhand der GitHub-ID ermittelt werden, falls Fragen zum Inhalt aufkommen oder inhaltliche Probleme vorliegen. In einigen Fällen benachrichtigt die GitHub-Automatisierung den Autor über Aktivitäten im Zusammenhang mit der Datei.
description Eine Zusammenfassung des Inhalts (75–300 Zeichen) Wird beim Durchsuchen der Website und manchmal auf der Ergebnisseite einer Suchmaschine zur Suchmaschinenoptimierung verwendet
ms.author Der Microsoft-Alias des Autors ohne „@microsoft.com“. Wenn Sie kein Microsoft-Mitarbeiter sind, suchen Sie einen geeigneten Microsoft-Mitarbeiter, dessen Alias in diesem Feld verwendet werden kann. Hiermit wird der Besitzer des Artikels kenntlich gemacht. Der Besitzer ist für Entscheidungen über den Inhalt des Artikels sowie für die Berichterstellung und die BI des Artikels verantwortlich.
ms.date Ein Datum im Format MM/TT/JJJJ. Dieses Datum wird auf der veröffentlichten Seite angezeigt, um kenntlich zu machen, wann der Artikel zuletzt wesentlich überarbeitet wurde oder um dessen Aktualität zu garantieren. Das Datum wird ohne Uhrzeit eingegeben und als 0:00 Uhr in der Zeitzone UTC (koordinierte Weltzeit) interpretiert. Das den Benutzern angezeigte Datum wird in die jeweilige Zeitzone konvertiert.
title Der Seitentitel Dies ist der Seitentitel, der auf der Browserregisterkarte angezeigt wird. Dies sind die wichtigsten Metadaten für SEO.

Bei Attributen wird die Groß-/Kleinschreibung beachtet. Geben Sie sie genau wie aufgeführt ein, und verwenden Sie einen Doppelpunkt und ein Leerzeichen zwischen den Attributen und dem Wert. Wenn ein Attributwert einen Doppelpunkt (:), einen Hash (#) oder ein anderes Sonderzeichen enthält, müssen Sie ihn entweder in einfache (') oder doppelte Anführungszeichen (") einschließen. Zum Beispiel:

---
title: 'Quickstart: How to use hashtags (#) to make a point on the internet'
---
# Heading 1 <!-- the article title to show on the web page -->