Anuncio de la extensión Docs Markdown para Visual Studio Code

El autor de este artículo es Adam Kinney, ingeniero principal de software en el equipo de docs.microsoft.com.

Hoy nos complace anunciar la publicación del Docs Authoring Pack (Módulo de creación de documentos) para Visual Studio Code, que simplifica más que nunca realizar contribuciones a docs.microsoft.com. Esta primera versión del módulo incluye tres extensiones:

  • Docs Markdown: ofrece ayuda para la creación de Markdown, lo que incluye dar formato al texto, insertar tablas y listas, insertar vínculos a otro contenido y agregar imágenes y otros recursos. A diferencia de otros editores de Markdown, Docs Markdown admite extensiones Markdown personalizadas para docs.microsoft.com, tales como alertas y fragmentos de código.
  • DocFX: ofrece una vista previa limitada de Markdown específica de docs.microsoft.com para que pueda ver el aspecto que tendrá el archivo Markdown cuando se publique.
  • markdownlint: popular linter de Markdown creado por David Anson para que pueda asegurarse de que en el archivo Markdown se siguen los procedimientos recomendados.

Cómo funciona

En primer lugar, debe instalarlo desde Visual Studio Marketplace. Cuando haya navegado a la página de la extensión, basta con hacer clic en Instalar y seguir los mensajes que aparecen en la pantalla:

Instalación de la extensión Docs Markdown

Cuando finalice, vuelva a cargar Visual Studio Code, abra un archivo Markdown y empiece a escribir. Use la combinación de teclas Alt+M para tener acceso a la paleta de comandos de la extensión Docs Markdown, que le permite dar formato rápidamente al texto (por ejemplo, ponerlo en negrita o en cursiva), insertar entidades de Markdown estándar (como una tabla o una lista numerada), así como insertar marcado específico de documentos para notas, información importante y sugerencias:

Paleta de comandos de la extensión

También puede insertar código de otros archivos rápidamente mediante una extensión Markdown compatible con DocFX y obtener la vista previa de la página en la que trabaja directamente en el editor:

Vista previa de la página que se edita actualmente

Contribuir

La extensión es de código abierto y le agradecemos las contribuciones que le haga.

La mayoría de las contribuciones requieren que acepte un contrato de licencia de colaborador (CLA) donde se afirma que tiene derecho, y de hecho lo hace, para otorgarnos derechos para usar su contribución. Para obtener más información, visite https://cla.microsoft.com.

Cuando se envía una solicitud de incorporación de cambios, un bot de CLA determinará automáticamente si tiene que aportar un CLA y completar la PR adecuadamente (p. ej., etiqueta, comentario). Basta con seguir las instrucciones indicadas por el bot. Solo tendrá que hacerlo una vez en todos los repositorios propiedad de Microsoft mediante nuestro CLA.

Comentarios

¿Tiene alguna idea de cómo podemos mejorar la extensión? Basta con abrir un nuevo problema.

No olvide seguir nuestro blog y nuestra cuenta de Twitter para recibir las actualizaciones más recientes.

¿Sueña con mejorar el mundo de los desarrolladores? Únase a nuestro equipo.