Guía de sintaxis para el uso de Markdown en wiki

Azure DevOps Services | Azure DevOps Server 2020 | Azure DevOps Server 2019 | TFS 2018

Importante

Seleccione una versión en el selector de versiones del contenido de Azure DevOps.

A fin de ver el contenido disponible para la plataforma, asegúrese de seleccionar la versión correcta de este artículo en el selector de versiones que se encuentra sobre la tabla de contenidos. La compatibilidad con características difiere en función de si se trabaja en Azure DevOps Services o una versión local de Azure DevOps Server, anteriormente denominado Team Foundation Server (TFS).
Vea ¿Qué plataforma o versión estoy usando? para obtener información sobre la versión local que utiliza.

En este artículo, encontrará algunas instrucciones de sintaxis de Markdown específicas de Wiki para su uso en Azure DevOps.

Tabla de contenido (TOC) para páginas Wiki

Para crear una tabla de contenido, agregue un [[_TOC_]]. El TOC se genera cuando se agrega la etiqueta y hay al menos un encabezado en la página.

Tabla de contenido

[[_TOC_]] se puede colocar en cualquier lugar de la página para representar la tabla de contenido. Solo se tienen en cuenta los encabezados de Markdown para TOC (no se tienen en cuenta las etiquetas de encabezado HTML).

Todas las etiquetas HTML y Markdown se quitan de los encabezados mientras se agregan dentro del bloque TOC. Vea el ejemplo siguiente de cómo se representa la TABLA al agregar negrita y cursiva a un encabezado.

Etiquetas para TOC

La coherencia se mantiene en el formato de TOC.

Nota

La etiqueta [[_TOC_]] distingue mayúsculas de minúsculas. Por ejemplo, [[_toc_]] puede no representar el TOC. Además, solo se representa la primera instancia de [[_TOC_]] y el resto se omite.

Agregar diagramas de Granía a una página Wiki

Wiki admite los siguientes tipos de diagrama de Diagram:

Para agregar diagramas de Lugar a una página wiki, use la sintaxis siguiente:

::: mermaid
<mermaid diagram syntax>
:::

También hay un botón de barra de herramientas para agregar un diagrama predeterminado Desaprobaciones a una página wiki.

Objeto visual diagrama de diagrama de

Nota

  • La mayoría de las etiquetas HTML y fontawesome no se admiten en la sintaxis del diagrama Desacciones.
  • No se admite la insondación en Internet Explorer explorador.
  • Los vínculos de tipo diagrama anteriores van a una versión más reciente de La matriz, que puede incluir cierta sintaxis que no es compatible con Azure DevOps. Por ejemplo, en el caso de los diagramas de flujo, se admite LongArrow en el editor en directo ----> de Inversiones, pero no en Azure DevOps.

Inserción de vídeos en una página Wiki

Para insertar vídeos de YouTube y Microsoft Secuencias en una página wiki, use la sintaxis siguiente:

::: video
<iframe width="560" height="315" src="https://www.youtube.com/embed/OtqFyBA6Dbk" frameborder="0" allow="autoplay; encrypted-media" allowfullscreen></iframe>
:::

El iframe es el bloque de iframe para insertar del vídeo de YouTube Secuencias Microsoft.

Resultado:

(El final ":::" es necesario para evitar una interrupción en la página)

Etiquetas YAML

Cualquier archivo que contiene un bloque YAML en una wiki se procesa mediante una tabla con un encabezado y una fila. El bloque YAML debe ser lo primero en el archivo y debe tener la forma de conjunto de YAML válido entre líneas de tres guiones. Admite todos los tipos de datos básicos, listas y objetos como valores. La sintaxis se admite en wiki, versión preliminar del archivo de código.

Ejemplo básico:

---
tag: post
title: Hello world
---

Etiqueta YAML, ejemplo básico

Etiquetas con lista:

---
tags:
- post
- code
- web
title: Hello world
---

Ejemplo de etiquetas YAML con lista

Inserción Azure Boards resultados de la consulta en Wiki

Para insertar Azure Boards resultados de una consulta en una página wiki como una tabla, use la sintaxis siguiente:

::: query-table <queryid>
:::

Por ejemplo:

::: query-table 6ff7777e-8ca5-4f04-a7f6-9e63737dddf7 :::

También puede usar la barra de herramientas y el selector de consultas para insertar los resultados de la consulta en una página wiki.

Icono resultados de la consulta

Panel Selector de consultas

Para obtener más información sobre cómo copiar la dirección URL de consulta, que proporciona un GUID para la consulta, vea Elementos de consulta de correo electrónico o Dirección URL de consulta de recurso compartido.

@mention usuarios y grupos

Para @mention usuarios o grupos en wiki, clave en "@" en el editor de wikis. En @mention se abre autosuggest, desde el que puede mencionar usuarios o grupos para recibir notificaciones por correo electrónico.

Mencione Autosuggest

También puede seleccionar "@mention" en la barra de herramientas de edición.

Mención de la barra de herramientas de edición

Cuando edite páginas directamente en el código, use el siguiente patrón, @<{identity-guid}> .

Visitas a páginas para páginas wiki

Automáticamente, verá un recuento agregado de visitas a páginas durante los últimos 30 días en cada página.

Use la API por pagesBatch lotes para ver la cantidad diaria de visitas a todas las páginas de forma paginada. Sin embargo, no se ordenan por número de visitas. Para los datos de más de 30 días de antigüedad, puede obtener todas las visitas a la página mediante la API rest. Ordene estas páginas en función del número de visitas para obtener las 100 primeras. Puede almacenar estas visitas en un panel o una base de datos.

Visitas a la página wiki

Nota

Un usuario determinado define una visita de página como una vista de página en un intervalo de 15 minutos.

Escriba el signo de perd ( # ) y, a continuación, escriba un identificador de elemento de trabajo.

Nota

Esta característica está disponible con TFS 2018.2 y versiones posteriores.

Compatibilidad con etiquetas HTML en páginas wiki

En las páginas wiki, también puede crear contenido enriquecido mediante etiquetas HTML.

Sugerencia

Puede anidar Markdown en el código HTML, pero debe incluir una línea en blanco entre el elemento HTML y markdown.

<p>
 
 [A markdown link](https://microsoft.com) 
</p>

Nota

Se admite pegar contenido enriquecido como HTML en Azure DevOps Server 2019.1 y versiones posteriores.

Ejemplo: vídeo insertado

<video src="path of the video file" width=400 controls>
</video>
<video src="https://sec.ch9.ms/ch9/7247/7c8ddc1a-348b-4ba9-ab61-51fded6e7247/vstswiki_high.mp4" width=400 controls>
</video>

Ejemplo: formato de texto enriquecido

<p>This text needs to <del>strikethrough</del> <ins>since it is redundant</ins>!</p>
<p><tt>This text is teletype text.</tt></p>
<font color="blue">Colored text</font>
<center>This text is center-aligned.</center>
<p>This text contains <sup>superscript</sup> text.</p>
<p>This text contains <sub>subscript</sub> text.</p>
<p>The project status is <span style="color:green;font-weight:bold">GREEN</span> even though the bug count / developer may be in <span style="color:red;font-weight:bold">red.</span> - Capability of span
<p><small>Disclaimer: Wiki also supports showing small text</small></p>
<p><big>Bigger text</big></p>

Resultado:

Vista de tema claro

Vista de tema oscuro