Seitenstrukturen

Auf MDN gibt es Dokumentstrukturen, die verwendet werden, um eine konsistente Darstellung von Informationen in MDN-Artikeln zu gewährleisten. Diese Seite listet Artikel auf, die diese Strukturen beschreiben, damit Sie den Seiteninhalt für die Dokumente, die Sie schreiben, bearbeiten oder übersetzen, entsprechend anpassen können.

Banner und Hinweise werden auf einigen Seiten, insbesondere in API-Referenzen, angezeigt, um wichtige Faktoren hervorzuheben, die die Nutzung des beschriebenen Inhalts beeinflussen werden. Zum Beispiel werden Banner genutzt, um hervorzuheben, wenn eine bestimmte Schnittstelle, Methode oder Eigenschaft veraltet ist und nicht im Produktivcode verwendet werden sollte, oder nur in einem sicheren Kontext benutzt werden kann.

Browser-Kompatibilitätstabellen und Browser-Kompatibilitätsdaten (BCD)

MDN hat ein Standardformat für Tabellen, die die Kompatibilität gemeinsamer Technologien über alle Browser hinweg darstellen, wie DOM, HTML, CSS, JavaScript, SVG usw. Um diese Daten in mehreren Projekten programmatisch verfügbar zu machen, wird ein Node.js-Paket aus dem browser-compat-data-Repository erstellt und auf npm veröffentlicht.

Code-Beispiele auf MDN

Auf MDN finden Sie zahlreiche Code-Beispiele, die demonstrieren, wie Sie Webplattform-Funktionen, die wir dokumentieren, nutzen können. Dieser Artikel beschreibt, auf welche Weise Sie Code-Beispiele zu Seiten hinzufügen können, welche Typen Sie verwenden können und wann Sie diese verwenden sollten.

Feature-Status

Warnung: Aktualisieren Sie die Feature-Status im mdn/content Repository nicht manuell. Die Dokumentationsquelle wird automatisch aktualisiert anhand von Informationen im GitHub mdn/browser-compat-data Repository.

MDN bietet zahlreiche Makros, um stets aktuelle Links zu MDN-Inhalten zu erstellen. In diesem Leitfaden erfahren Sie mehr über MDN-Querverweis-Makros, die Sie nutzen können, um einen einzelnen Link zu einer anderen Seite oder eine Liste von Links zu allen Unterseiten eines Dokuments einzufügen.

Live-Beispiele (EmbedLiveSample)

MDN unterstützt das Anzeigen von Codeblöcken in den Artikeln als Live-Beispiele, sodass die Leser sowohl den Quellcode als auch dessen Ausgabe sehen können, wie er auf einer Webseite aussieht. Diese Funktion ermöglicht es den Lesern, genau zu verstehen, was der ausgeführte Code erzeugen würde, was die Dokumentation dynamisch und lehrreich macht. Es erlaubt auch den Autoren, absolut sicher zu sein, dass die Codeblöcke in der Dokumentation die erwartete Ausgabe haben und ordnungsgemäß funktionieren, wenn sie in verschiedenen Browsern verwendet werden.

Polyfills

Diese Seite beschreibt MDNs Richtlinien für die Aufnahme von Polyfills in die Referenzdokumentation für JavaScript und Web-APIs.

Seitenleisten

MDN-Seiten enthalten alle Seitenleisten. Die meisten davon werden mit einem Standardsystem erstellt, das Datenstrukturen in YAML-Dateien definiert und Seitenleisten mithilfe von Makroaufrufen auf Seiten einfügt.

Seitentypen

Es gibt eine Vielzahl von Seitentypen, die auf MDN wiederholt verwendet werden. Dieser Artikel beschreibt diese Seitentypen, ihre Zwecke und gibt Beispiele sowie Vorlagen zum Erstellen einer neuen Seite.

Spezifikationstabellen

Jede Referenzseite auf MDN sollte Informationen über die Spezifikation oder Spezifikationen enthalten, in denen diese API oder Technologie definiert wurde. Dieser Artikel zeigt, wie diese Tabellen aussehen und erklärt, wie sie hinzugefügt werden.

Syntax-Abschnitte

Der Syntax-Abschnitt einer MDN-Referenzseite enthält ein Syntaxfeld, das die genaue Syntax eines Features definiert (z. B. welche Parameter es akzeptieren kann, welche optional sind). Dieser Artikel erklärt, wie Syntaxfelder für Referenzartikel geschrieben werden.

Verwendung von Makros

Das rari-Backend ist das Build-System von MDN und bietet eine Makro-Syntax für häufige Aufgaben.

Siehe auch