Nueva versión del módulo de creación de documentos para VS Code

La autora de esta publicación es Megan Bradley, jefa de programas sénior del equipo de docs.microsoft.com.

En abril, anunciamos la primera versión de Docs Authoring Pack para VS Code, que incluye la extensión Docs Markdown, la cual permite obtener una vista previa de las ediciones basadas en DocFX, así como markdownlint. Hoy nos complace anunciar la segunda versión principal de Docs Authoring Pack, que incluye las siguientes extensiones nuevas:

  • Code Spell Checker. A petición popular, hemos incluido este corrector ortográfico sin conexión de Street Side Software para que los colaboradores puedan revisar todo su contenido, incluidos ejemplos de código, sin necesidad de hacerlo mediante un servicio en línea.
  • Docs Article Templates. Esta extensión permite aplicar una plantilla de Markdown a un nuevo archivo, lo que facilita la creación de contenido y metadatos de una manera coherente.
  • Docs Preview. Se trata de un reemplazo de la versión preliminar de DocFx incluida en la primera versión de Docs Authoring Pack. La nueva extensión en versión preliminar es mucho más sólida y representa el CSS de docs.microsoft.com con mayor fidelidad.

Puede instalar las extensiones individualmente, mediante los vínculos anteriores o en un único paquete a través de Docs Authoring Pack.

Presentación de las plantillas de artículo

Las plantillas de artículo son archivos Markdown de esqueleto que proporcionan encabezados estándar, metadatos de archivo, texto reutilizable y otros elementos básicos que siguen las directrices de docs.microsoft.com, lo que facilita la aportación de nuevos artículos y elimina las dudas sobre los requisitos de publicación.

Para crear un archivo basado en una plantilla existente, simplemente presione Alt+M y seleccione Plantilla:

Aplicación de la plantilla

Mejor vista previa

El antiguo motor de vista previa basado en DocFX se ha reemplazado por el nuevo Docs Preview, que incluye las siguientes mejoras:

  • Compatibilidad con el analizador Markdig compatible con CommonMark, en lugar de DocFx Flavored Markdown (DFM).
  • CSS de docs.microsoft.com actualizado, que representa los elementos Markdown personalizados con mayor fidelidad.
  • Confiabilidad mejorada, lo que hace que las vistas previas se representen más rápido y sin retrasos.
  • Compatibilidad con la lista cada vez mayor de extensiones de Markdown específicas de Docs, a medida que están disponibles.

Contribuir

Las extensiones de Docs Markdown son de código abierto. Por supuesto, agradecemos las contribuciones.

Tenga en cuenta que 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 en nuestro software y contenido. Para más detalles, visite https://cla.microsoft.com. Cuando se envía una solicitud de incorporación de cambios, un bot de CLA determinará de forma automática si tiene que aportar un CLA y completar la PR adecuadamente (por ejemplo, la etiqueta, el comentario). Solo siga las instrucciones que le dará el bot. Solo tendrá que hacerlo una vez en todos los repositorios propiedad de Microsoft.

Comentarios

¿Tiene alguna idea de cómo podemos mejorar las extensiones? Solo tiene que abrir un nuevo asunto.

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

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