Estructura de páginas
A lo largo de MDN existen estructuras de documentos que se utilizan para proporcionar una presentación coherente de la información en los artículos de MDN. Esta página enumera artículos que describen estas estructuras para que pueda modificar el contenido de la página de manera adecuada para los documentos que escribe, edita o traduce.
- Banners y avisos
Se agregan banners a algunas páginas, en particular a la referencia de la API, para resaltar factores importantes que afectarán la forma en que se usa el contenido descrito. Por ejemplo, los banners se usan para resaltar cuándo una interfaz, un método o una propiedad en particular están obsoletos y no deben usarse en el código de producción.
- Ejemplos de código
En MDN, encontrarás numerosos ejemplos de código insertados en las páginas para demostrar el uso de las características de la plataforma web. Este artículo discute los diferentes mecanismos disponibles para agregar ejemplos de código a las páginas, junto con cuáles debes usar y cuándo.
- 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.
- Enlaces rápidos
MDN admite la adición de enlaces rápidos a las páginas; estos son cuadros que contienen una lista potencialmente jerárquica de enlaces a otras páginas en MDN o a páginas fuera del sitio. Este artículo describe cómo crear enlaces rápidos.
MDN tiene un formato estándar para tablas que ilustran la compatibilidad de tecnologías compartidas en todos los navegadores, como DOM, HTML, CSS, JavaScript, SVG, etc. Para que estos datos estén disponibles en varios proyectos mediante programación, se crea un paquete de Node.js desde el repositorio
browser-compat-datay se publica en npm.- 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.
- 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.