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 angezeigt, insbesondere in der API-Referenz, 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 in Produktionscode nicht 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 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 zeigen, wie die von uns dokumentierten Funktionen der Webplattform verwendet werden können. Dieser Artikel beschreibt die verschiedenen Möglichkeiten, Code-Beispiele zu Seiten hinzuzufügen, die Arten von Beispielen, die Sie verwenden können, und wann Sie welche einsetzen sollten.

Feature-Status

Ein Feature-Status bietet Entwicklern Informationen über den Implementierungsstand eines Features bei Browser-Anbietern und ist einer der folgenden:

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

Live-Beispiele (EmbedLiveSample)

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

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 Anzahl von Seitentypen, die auf MDN wiederholt verwendet werden. Dieser Artikel beschreibt diese Seitentypen, deren Zweck und gibt Beispiele sowie Vorlagen für jeden Typ, die verwendet werden können, um eine neue Seite zu erstellen.

Spezifikationstabellen

Jede Referenzseite auf MDN sollte Informationen über die Spezifikation(en) bereitstellen, in der/denen diese API oder Technologie definiert wurde. Dieser Artikel zeigt, wie diese Tabellen aussehen und erklärt, wie man sie hinzufügt.

Syntax-Abschnitte

Der Syntax-Abschnitt einer MDN-Referenzseite enthält eine Syntaxbox, die die genaue Syntax eines Features definiert (z. B. welche Parameter akzeptiert werden können, welche optional sind). Dieser Artikel erklärt, wie Syntaxboxen für Referenzartikel erstellt 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