Documentação de metadados para o Microsoft Learn

Os metadados podem ser aplicados no artigo (na matéria frontal do YAML) ou globalmente no arquivo de docfx.json para o repositório. Se você estiver fazendo uma edição em um artigo existente, provavelmente não precisará alterar nenhum metadado. No entanto, se você estiver adicionando um novo artigo, há certos atributos de metadados necessários que você precisará incluir na matéria frontal do YAML do arquivo.

Aqui está um exemplo de metadados aplicados na matéria frontal do YAML de um artigo 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 -->

Metadados necessários

A tabela a seguir mostra os atributos de metadados necessários. Se você omitir qualquer um deles, provavelmente receberá um erro de validação durante a compilação.

Campo	Valor	Porquê?
author	O ID da conta do autor no GitHub.	Identifica o autor pelo ID do GitHub caso haja dúvidas ou problemas com o conteúdo. Em alguns casos, a automação do GitHub pode notificar o autor da atividade envolvendo o arquivo.
description	Um resumo do conteúdo. 75-300 caracteres.	Usado na pesquisa do site. Às vezes usado em uma página de resultados do mecanismo de pesquisa para melhorar o SEO.
ms.author	O alias Microsoft do autor, sem "@microsoft.com". Se você não for um funcionário da Microsoft, encontre um funcionário da Microsoft adequado para usar neste campo.	Identifica o proprietário do artigo. O proprietário é responsável pelas decisões sobre o conteúdo do artigo, e pelo relatório e BI do artigo.
ms.date	Uma data no formato MM/DD/AAAA.	Exibido na página publicada para indicar a última vez que o artigo foi substancialmente editado ou garantido fresco. A data é inserida sem hora e é interpretada como 0:00 e no fuso horário UTC. A data exibida aos usuários é convertida em seu fuso horário.
title	O título da página.	Este é o título da página exibido na guia do navegador. São os metadados mais importantes para SEO.

Os atributos diferenciam maiúsculas de minúsculas. Insira-os exatamente como listado e use dois pontos e um espaço entre os atributos e o valor. Se um valor de atributo incluir dois pontos (:), um hash (#) ou qualquer outro caractere especial, você deverá colocá-lo entre aspas simples (') ou duplas ("). Por exemplo:

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