Metadatos para la documentación de Microsoft Learn

Los metadatos se pueden aplicar en el artículo (en la parte frontal de YAML) o globalmente en el archivo docfx.js del repositorio. Si va a editar un artículo existente, probablemente no tendrá que cambiar ningún metadato. Sin embargo, si va a agregar un nuevo artículo, hay ciertos atributos de metadatos necesarios que deberá incluir en la parte frontal de YAML del archivo.

Este es un ejemplo de metadatos aplicados en la materia principal de YAML de un artículo de Markdown:

---
title:                     # the article title to show on the browser tab
description:               # 115 - 145 character description to show in search results
author: {github-id}        # the author's GitHub ID - will be auto-populated if set in settings.json
ms.author: {ms-alias}      # the author's Microsoft alias (if applicable) - will be auto-populated if set in settings.json
ms.date: {@date}           # the date - will be auto-populated when template is first applied
ms.topic: getting-started  # the type of article
---
# Heading 1 <!-- the article title to show on the web page -->

Metadatos necesarios

En la tabla siguiente se muestran los atributos de metadatos necesarios. Si omite cualquiera de estos, es probable que reciba un error de validación durante la compilación.

Campo	Valor	¿Por qué?
author	El id. de la cuenta de GitHub del autor.	Identifica al autor mediante el id. de GitHub en caso de que haya preguntas sobre el contenido o problemas con él. En algunos casos, la automatización de GitHub podría notificar al autor de la actividad relacionada con el archivo.
description	Resumen del contenido. Entre 75 y 300 caracteres.	Se usa en la búsqueda del sitio. A veces se usa en una página de resultados del motor de búsqueda para mejorar la optimización del motor de búsqueda.
ms.author	Alias de Microsoft del autor, sin "@microsoft.com". Si no es un empleado de Microsoft, busque un empleado de Microsoft adecuado para usarlo en este campo.	Identifica el propietario del artículo. El propietario es responsable de las decisiones sobre el contenido del artículo, así como de los informes y la inteligencia empresarial sobre el artículo.
ms.date	fecha con formato MM/DD/AAAA.	Se muestra en la página publicada para indicar la última vez que el artículo se editó de manera sustancial o se garantizó que está actualizado. La fecha se indica sin hora y se interpreta como 0:00 y en la zona horaria UTC. La fecha que se muestra a los usuarios se convierte a su zona horaria.
title	Título de la página.	Este es el título de página que se muestra en la pestaña del explorador. Son los metadatos más importantes para el SEO.

Los atributos distinguen mayúsculas de minúsculas. Escríbalos exactamente como se muestra y use dos puntos y un espacio entre los atributos y el valor. Si un valor de atributo incluye dos puntos (:), una almohadilla (#) o cualquier otro carácter especial, debe incluir comillas simples (') o dobles ("). Por ejemplo:

---
title: 'Quickstart: How to use hashtags (#) to make a point on the internet'
---
# Heading 1 <!-- the article title to show on the web page -->