Guías prácticas
Esta sección de las guías de escritura de MDN Web Docs contiene toda la información paso a paso para realizar tareas específicas al contribuir a MDN Web Docs: cómo usamos Markdown, cómo agregamos una entrada al glosario, cómo movemos o eliminamos páginas y más. Para saber más sobre cómo contribuir (que se realiza a través de GitHub), consulta nuestras guías de contribución.
Nota:
A lo largo de esta sección, asumimos que ha leído las guías de contribución, está familiarizado con el repositorio mdn/content y sabe cómo usar git y GitHub.
- ¿Cómo escribir una entrada en el glosario?
Este artículo explica cómo agregar y vincular entradas en el glosario de MDN Web Docs. También proporciona pautas sobre el diseño y el contenido de las entradas del glosario. El glosario proporciona definiciones para todos los términos, jerga, abreviaturas y acrónimos que encontrará al leer contenido de MDN sobre la web y el desarrollo web.
- Cómo añadir imágenes y medios
Para agregar una imagen a un documento, añade el archivo de imagen a la carpeta del documento y luego referencia la imagen desde dentro del archivo
index.mddel documento usando la sintaxis de imagen de Markdown o el elemento HTML<img>equivalente.- Cómo documentar errores web
La Referencia de errores de JavaScript en MDN Web Docs es un proyecto para ayudar a los desarrolladores web con los errores que ocurren en la Consola de desarrollador. Para este proyecto, necesitamos escribir más documentación de errores en MDN Web Docs para que podamos agregar más enlaces a las herramientas donde se lanzan los mensajes. Este artículo explica cómo documentar los errores web.
- Cómo documentar una cabecera HTTP
La referencia de cabeceras HTTP en los campos de cabeceras HTTP de los documentos de MDN Web Docs. Son componentes de la sección de cabecera de los mensajes de solicitud y respuesta en el Protocolo de Transferencia de Hipertexto (HTTP). Definen los parámetros operativos de una transacción HTTP. Este artículo explica cómo crear una nueva página de referencia para una cabecera HTTP.
- Cómo documentar una propiedad CSS
A medida que evolucionan los estándares CSS, siempre se agregan nuevas propiedades. La Referencia de CSS en MDN Web Docs debe mantenerse actualizada con estos desarrollos. Este artículo proporciona instrucciones paso a paso para crear una página de referencia de propiedades CSS.
- Cómo escribir en Markdown
Esta página describe cómo usamos Markdown para escribir documentación en MDN Web Docs. Hemos elegido un Markdown personalizado por GitHub (GFM, por sus siglas en inglés ―GitHub-Flavored Markdown―) como base y agregamos algunas extensiones para admitir algunas de las cosas que necesitamos hacer en MDN que no son fácilmente compatibles con GFM.
- Cómo investigar una tecnología
Este artículo le brinda información útil sobre cómo abordar la documentación de tecnologías.
- Cómo usar datos estructurados
MDN almacena los datos en estructuras bien definidas cuando es posible. Esta información se centraliza y se puede actualizar una vez, mientras se utiliza en numerosos lugares.