Apresentação da nova Extensão Docs Markdown para Visual Studio Code

Esta mensagem foi escrita por Adam Kinney, Engenheiro de Software Sénior na equipa de docs.microsoft.com.

Hoje, temos o prazer de anunciar o lançamento do Pacote de Criação de Documentos para Visual Studio Code, tornando mais fácil do que nunca contribuir para 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, inserir listas e tabelas, inserir ligações para outro conteúdo e adicionar imagens e outros elementos. Ao contrário de outros editores de Markdown, o Docs Markdown suporta extensões Markdown personalizadas para docs.microsoft.com, como alertas e fragmentos de código.
• DocFX - fornece uma pré-visualização de Markdown limitada e específica do docs.microsoft.com, para ajudar a ver qual será o aspeto do ficheiro Markdown quando publicado.
• markdownlint - um linter Markdown popular por David Anson, para ajudar a garantir que o Markdown segue as melhores práticas.

Como Funciona

Primeiro, precisa de instalá-lo a partir do Visual Studio Marketplace. Depois de navegar para a página da extensão, basta clicar em Instalar e seguir as mensagens no ecrã:

Quando tiver terminado, deve recarregar o Visual Studio Code, abrir um ficheiro de Markdown e começar a escrever! Utilize a combinação de chaves Alt+M para aceder à paleta de comandos da Extensão Docs Markdown, permitindo-lhe formatar rapidamente o texto da chave (por exemplo, tornando-o negrito ou itálico), inserir entidades Markdown padrão, como uma lista numerada ou uma tabela, bem como inserir marcações específicas de documentos para notas, informações importantes e sugestões:

Pode também inserir rapidamente o código de outros ficheiros através de uma extensão de Markdown compatível com DocFX e pré-visualizar a página na qual está a trabalhar diretamente no editor:

Contribuir

A extensão é open source, e apreciamos quaisquer contribuições para a mesma!

A maioria das contribuições requer que aceite um CLA (Contrato de Licença de Contribuição) declarando que tem o direito, e o exerce, de conceder-nos os direitos para utilizarmos a sua contribuição. Para mais detalhes, visite https://cla.microsoft.com.

Quando submete um pedido Pull, um bot do CLA determina automaticamente se tem de fornecer um CLA e decorar o PR de forma adequada (por exemplo, etiqueta, comentário). Só tem de seguir as instruções fornecidas pelo bot. Apenas terá de fazer isto uma vez em todos os repositórios pertencentes à Microsoft, com o nosso CLA.

Comentários

Tem opiniões sobre como podemos melhorar a extensão? Basta abrir uma nova questão!

E não se esqueça de seguir a nossa conta do Twitter para conhecer as atualizações mais recentes.

Sonha em tornar o mundo melhor para os programadores? Junte-se à nossa equipa!