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 der API-Referenz, um wichtige Faktoren hervorzuheben, die die Nutzung des beschriebenen Inhalts beeinflussen werden. Zum Beispiel werden Banner verwendet, um hervorzuheben, wenn eine bestimmte Schnittstelle, Methode oder Eigenschaft veraltet ist und nicht in Produktionscode 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 werden Sie zahlreiche Code-Beispiele sehen, die demonstrieren, wie man die von uns dokumentierten Webplattform-Funktionen verwendet. Dieser Artikel beschreibt die Möglichkeiten, Code-Beispiele auf Seiten hinzuzufügen, die Arten, die Sie verwenden können und wann sie zu verwenden sind.

Feature-Status

Ein Feature-Status gibt im Allgemeinen den plattformübergreifenden Implementierungs- und Standardisierungsstatus einer bestimmten Webplattform-Funktion an, wie z.B. eine Web-API-Methode oder eine CSS-Eigenschaft.

Link-Makros

MDN bietet zahlreiche Makros, mit denen Sie Links zu MDN-Inhalten erstellen können, die immer auf dem neuesten Stand sind. In diesem Leitfaden lernen Sie MDN-Makros für Querverweise kennen. Damit können Sie einen einzelnen Link zu einer anderen Seite oder eine Liste mit Links zu allen Unterseiten eines Dokuments einfügen.

Live-Beispiele (EmbedLiveSample)

MDN unterstützt die Darstellung von Codeblöcken innerhalb von Artikeln als Live-Beispiele. So können Leserinnen und Leser sowohl den Quellcode als auch dessen Ausgabe sehen, wie sie auf einer Webseite erscheint. Diese Funktion macht die Dokumentation anschaulich und hilft dabei, genau zu verstehen, welche Ausgabe der ausgeführte Code erzeugt. Außerdem können Autorinnen und Autoren so sicherstellen, dass die Codeblöcke in der Dokumentation die erwartete Ausgabe erzeugen und in verschiedenen Browsern wie vorgesehen funktionieren.

Polyfills

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

Seitenleisten

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

Seitentypen

Auf MDN werden wiederholt verschiedene Arten von Seiten verwendet. Dieser Artikel beschreibt diese Seitentypen, ihren Zweck und enthält Beispiele für jeden Typ sowie Vorlagen, die Sie beim Erstellen einer neuen Seite verwenden können.

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.

Syntaxabschnitte

Der Syntaxabschnitt einer MDN-Referenzseite enthält eine Syntaxbox, die die genaue Syntax eines Features definiert (z. B. welche Parameter kann es akzeptieren, welche davon sind optional?). Dieser Artikel erklärt, wie Syntaxboxen für Referenzartikel geschrieben werden.

Verwendung von Makros

Das rari Backend ist das Builds-System von MDN und bietet eine Makrosyntax für gängige Aufgaben.