Uma nova versão do pacote de criação do Docs para VS Code

Esta postagem foi escrita por Megan Bradley, gerente de programa sênior na equipe docs.microsoft.com.

Em abril, anunciamos a primeira versão do Pacote de Criação do Docs para VS Code, que inclui a extensão Markdown do Docs, uma extensão para visualizar edições baseada no DocFX, bem como o markdownlint. Hoje, temos a satisfação de anunciar a segunda versão principal do Pacote de Criação do Docs, que inclui as seguintes novas extensões:

• Verificação ortográfica de código. Pela demanda popular, empacotamos esse verificador ortográfico offline com o Street Side Software, para que os colaboradores possam verificar todos os conteúdos, incluindo exemplos de código, sem precisar usar um serviço online.
• Modelos de artigos do Docs. Essa extensão permite que você aplique um modelo Markdown a um novo arquivo, facilitando a criação de conteúdo e metadados de maneira consistente.
• Visualização do Docs. A substituição da visualização do DocFx incluída na primeira versão do Pacote de Criação do Docs. A nova extensão de visualização é muito mais robusta e representa o CSS do docs.microsoft.com com mais fidelidade.

Você pode instalar as extensões individualmente, por meio dos links acima ou em um só pacote, por meio do Pacote de Criação do Docs.

Apresentação dos modelos de artigo

Os modelos de artigo são esqueletos de arquivos markdown que oferecem títulos padrão, metadados de arquivo, texto clichê e outros elementos básicos que seguem as diretrizes do docs.microsoft.com, facilitando a contribuição com novos artigos e eliminando as dúvidas sobre os requisitos de publicação.

Para criar um arquivo com base em um modelo existente, basta pressionar Alt+M e selecionar Modelo:

Visualização aprimorada

O antigo mecanismo de visualização baseado no DocFX foi substituído pela nova Visualização do Docs, que apresenta os seguintes aprimoramentos:

• Suporte para o analisador Markdig compatível com CommonMark, em vez do DFM (DocFx Flavored Markdown).
• CSS do docs.microsoft.com atualizado, que renderiza elementos Markdown personalizados com maior fidelidade.
• Confiabilidade aprimorada, acelerando a renderização das visualizações e eliminando atrasos.
• Suporte para a lista cada vez maior de extensões Markdown específicas do Docs, conforme elas ficam disponíveis.

Contribuir

As extensões Markdown do Docs são de código aberto e contribuições são bem-vindas!

Saiba que a maioria das contribuições exige que você concorde com um CLA (Contrato de Licença de Colaborador) afirmando que você nos concede os direitos de usar a contribuição em nossos softwares e conteúdos e tem autoridade para fazer essa concessão. Para obter detalhes, visite https://cla.microsoft.com. Quando você envia uma solicitação de pull, um bot do CLA determina automaticamente se você precisa fornecer um CLA e preencher a PR corretamente (por exemplo, rótulo, comentário). Basta seguir as instruções fornecidas pelo bot. Você só precisará fazer isso uma vez em todos os repositórios de propriedade da Microsoft.

Comentários

Você tem ideias de como podemos aprimorar as extensões? Basta abrir um novo problema!

E não deixe de seguir nossa conta do Twitter para obter as atualizações mais recentes.

Sonha em fazer do mundo um lugar melhor para os desenvolvedores? Junte-se à nossa equipe!