Anunciando a Extensão de Docs Markdown para Visual Studio Code

Esta postagem foi escrita por Adam Kinney, engenheiro de software sênior da equipe do docs.microsoft.com.

Hoje, temos o prazer de anunciar o lançamento do Docs Authoring Pack para Visual Studio Code, que torna mais fácil do que nunca contribuir para o docs.microsoft.com. Esta primeira versão do pacote inclui três extensões:

  • Docs Markdown – fornece assistência para a criação de Markdown, incluindo formatação de texto, inserção de listas e tabelas, inserção de links para outros tipos de conteúdo e adição de imagens e outros ativos. Diferente de outros editores de Markdown, o Docs Markdown dá suporte a extensões personalizadas de Markdown para docs.microsoft.com, como alertas e snippets de código.
  • DocFX – fornece uma visualização limitada, específica para o docs.microsoft.com, para ajudá-lo a ver como será a aparência de seu arquivo markdown quando ele for publicado.
  • markdownlint – um linter de Markdown popular de David Anson para ajudar a garantir que seu Markdown siga as melhores práticas.

Como funciona

Primeiro, você precisará instalá-lo do Visual Studio Marketplace. Após navegar para a página da extensão, basta clicar em Instalar e seguir as mensagens na tela:

Instalação da Extensão Docs Markdown

Depois disso, recarregue o Visual Studio Code, abra um arquivo markdown e comece a escrever! Use a combinação de telas Alt+M para acessar a paleta de comandos da Extensão Docs Markdown, que permite formatar rapidamente o texto (por exemplo, deixá-lo negrito ou itálico), inserir entidades de Markdown padrão, como uma lista numerada ou uma tabela, bem como inserir marcações específicas de documentos para anotações, informações importantes e dicas:

Paleta de comandos da extensão

Você também pode inserir rapidamente código de outros arquivos usando uma Extensão de Markdown compatível com o DocFX e visualizar a página em que está trabalhando diretamente no editor:

Visualizar a página editada atualmente

Contribuir

A extensão é de software livre e contribuições a ela são bem-vindos!

Para a maioria das contribuições, é necessário que você concorde com um CLA (Acordo de licença do colaborador) que afirma que você tem o direito de nos conceder, e que nos concede, o direito de usar sua contribuiçã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 que usam nosso CLA.

Comentários

Tem ideias de como podemos melhorar a extensão? 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!