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 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.

Funktionsstatus

Warnung: Aktualisieren Sie die Funktionsstatus im mdn/content-Repository nicht manuell. Die Dokumentationsquelle wird automatisch aktualisiert mit Informationen aus dem GitHub-Repository mdn/browser-compat-data.

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-Samples (EmbedLiveSample)

MDN unterstützt die Anzeige von Codeblöcken innerhalb von Artikeln als Live-Samples, damit Leser sowohl den Quellcode als auch dessen Ausgabe, wie sie auf einer Webseite aussieht, sehen können. Diese Funktion ermöglicht es den Lesern, genau zu verstehen, was der ausgeführte Code erzeugt, wodurch die Dokumentation dynamisch und lehrreich wird. Es erlaubt den Autoren auch, absolut sicher zu sein, dass die Codeblöcke in der Dokumentation die erwartete Ausgabe liefern und bei Verwendung mit verschiedenen Browsern ordnungsgemäß funktionieren.

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 Anzahl von Seitentypen, die auf MDN wiederholt verwendet werden. Dieser Artikel beschreibt diese Seitentypen, ihren Zweck und gibt Beispiele für jeden sowie Vorlagen zur Erstellung 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.

Syntaxabschnitte

Der Syntaxabschnitt einer MDN-Referenzseite enthält ein Syntaxfeld, das die genaue Syntax eines Features definiert (z. B. welche Parameter kann es akzeptieren, welche sind optional?). 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