Estructuras de página
En todo MDN existen estructuras de documentos que se utilizan para presentar la información de forma coherente en los artículos. Esta página enumera los artículos que describen estas estructuras para que puedas modificar el contenido de las páginas de manera adecuada en los documentos que escribas, edites o traduzcas.
- Banners y avisos
Los banners y avisos se muestran en algunas páginas, en particular en la referencia de la API, para destacar factores importantes que afectarán el uso del contenido descrito. Por ejemplo, los banners se usan para indicar cuándo una interfaz, un método o una propiedad en particular están obsoletos y no deben usarse en código de producción, o cuándo solo pueden usarse en un contexto seguro.
- Barras laterales
Todas las páginas de MDN deben tener barras laterales. La mayoría se crean con un sistema que define estructuras de datos en archivos YAML, e incluye barras laterales en las páginas mediante el front matter o una macro.
- Ejemplos de código en MDN
En MDN encontrarás numerosos ejemplos de código que muestran cómo usar las características de la plataforma web que documentamos. Este artículo describe las formas en que puedes agregar ejemplos de código a las páginas, junto con los tipos que puedes usar y cuándo usarlos.
- Ejemplos ejecutables
MDN admite la visualización de bloques de código dentro de los artículos como ejemplos en vivo, lo que permite a los lectores ver tanto el código como su salida tal como se vería en una página web. Esta característica permite a los lectores comprender exactamente qué produciría el código ejecutado, haciendo que la documentación sea dinámica e instructiva. También permite a los autores asegurarse de que los bloques de código en la documentación tengan la salida esperada y funcionen correctamente cuando se usen con diferentes navegadores.
- Estado de una característica
El estado de una característica indica, en términos generales, el estado de implementación y estandarización entre navegadores de una característica particular de la plataforma web, como un método de API web o una propiedad CSS.
- Macros de enlace
MDN ofrece numerosas macros para crear enlaces siempre actualizados a su contenido. En esta guía, aprenderás sobre las macros de referencia cruzada de MDN, las cuales puedes usar para incluir un único enlace a otra página o una lista de enlaces a todas las subpáginas de un documento.
- Polyfills
Esta página describe la política de MDN para incluir polyfills en la documentación de referencia de JavaScript y de las API web.
- Secciones de sintaxis
La sección de sintaxis de una página de referencia de MDN contiene un bloque de sintaxis que define la sintaxis exacta que tiene una característica (por ejemplo, ¿qué parámetros puede aceptar?, ¿cuáles son opcionales?). Este artículo explica cómo escribir bloques de sintaxis para los artículos de referencia.
- Tablas de especificaciones
Cada página de referencia en MDN debe proporcionar información sobre la especificación o especificaciones en las que se definió esa API o tecnología. Este artículo muestra el aspecto de estas tablas y explica cómo agregarlas.
MDN tiene un formato estándar para las tablas que ilustran la compatibilidad de tecnologías web compartidas en todos los navegadores: DOM, HTML, CSS, JavaScript, SVG, etc. Para que estos datos estén disponibles en múltiples proyectos de forma programática, se crea un paquete de Node.js a partir del repositorio
browser-compat-datay se publica en npm.- Tipos de página
MDN utiliza repetidamente varios tipos de páginas. Este artículo describe estos tipos de páginas y sus propósitos, además de ofrecer ejemplos de cada uno y plantillas para usar al crear una nueva página.
- Utilizando macros
La plataforma Yari en la que se ejecuta MDN, proporciona un sistema de macros, KumaScript que permite automatizar ciertas tareas. Este artículo proporciona información sobre cómo invocar las macros de MDN dentro de los artículos.