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

Banner und Hinweise werden auf einigen Seiten angezeigt, insbesondere in API-Referenzen, um wichtige Faktoren hervorzuheben, die beeinflussen, wie der beschriebene Inhalt verwendet wird. Zum Beispiel werden Banner verwendet, um hervorzuheben, wenn eine bestimmte Schnittstelle, Methode oder Eigenschaft veraltet ist und nicht im Produktivcode verwendet werden sollte, oder nur in einem sicheren Kontext verwendet werden kann.

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

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

Code-Beispiele auf MDN

Auf MDN finden Sie zahlreiche Code-Beispiele, die zeigen, wie Sie die von uns dokumentierten Funktionen der Webplattform nutzen können. Dieser Artikel beschreibt, wie Sie Code-Beispiele zu Seiten hinzufügen können, welche Typen es gibt und wann Sie diese verwenden sollten.

Feature-Status

Ein Feature-Status gibt im Allgemeinen den Umsetzungs- und Standardisierungsstatus eines bestimmten Web-Plattform-Features über verschiedene Browser hinweg an, wie zum Beispiel einer Web-API-Methode oder CSS-Eigenschaft.

Link-Makros

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 verwenden können, um entweder einen einzigen 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

Alle MDN-Seiten sollten Seitenleisten haben. Die meisten von ihnen werden mit einem System erstellt, das Datenstrukturen in YAML-Dateien definiert und Seitenleisten über Front Matter oder ein Makro auf Seiten einfügt.

Seitentypen

Es gibt eine Reihe von Seitentypen, die auf MDN wiederholt verwendet werden. Dieser Artikel beschreibt diese Seitentypen, ihren Zweck und gibt Beispiele für jeden sowie Vorlagen zur Verwendung beim 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 akzeptiert werden können, 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 gängige Aufgaben.